Class IgcCategoryXAxisComponent

Represents a IgxDataChartComponent category X axis.

IgcCategoryXAxisComponent class represents a IgxDataChartComponent category X axis.

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

ATTRIBUTE_NODE

ATTRIBUTE_NODE: number

CDATA_SECTION_NODE

CDATA_SECTION_NODE: number

COMMENT_NODE

COMMENT_NODE: number

DOCUMENT_FRAGMENT_NODE

DOCUMENT_FRAGMENT_NODE: number

DOCUMENT_NODE

DOCUMENT_NODE: number

DOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINED_BY: number

DOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_CONTAINS: number

DOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_DISCONNECTED: number

DOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_FOLLOWING: number

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number

DOCUMENT_POSITION_PRECEDING

DOCUMENT_POSITION_PRECEDING: number

DOCUMENT_TYPE_NODE

DOCUMENT_TYPE_NODE: number

ELEMENT_NODE

ELEMENT_NODE: number

ENTITY_NODE

ENTITY_NODE: number

ENTITY_REFERENCE_NODE

ENTITY_REFERENCE_NODE: number

NOTATION_NODE

NOTATION_NODE: number

PROCESSING_INSTRUCTION_NODE

PROCESSING_INSTRUCTION_NODE: number

TEXT_NODE

TEXT_NODE: number

accessKey

accessKey: string

accessKeyLabel

accessKeyLabel: string

assignedSlot

assignedSlot: HTMLSlotElement | null

attributes

attributes: NamedNodeMap

autocapitalize

autocapitalize: string

baseURI

baseURI: string

Returns node's node document's document base URL.

childElementCount

childElementCount: number

childNodes

childNodes: NodeListOf<ChildNode>

Returns the children.

children

children: HTMLCollection

Returns the child elements.

classList

classList: DOMTokenList

Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object.

className

className: string

Returns the value of element's class content attribute. Can be set to change it.

clientHeight

clientHeight: number

clientLeft

clientLeft: number

clientTop

clientTop: number

clientWidth

clientWidth: number

contentEditable

contentEditable: string

dataset

dataset: DOMStringMap

dir

dir: string

draggable

draggable: boolean

firstChild

firstChild: ChildNode | null

Returns the first child.

firstElementChild

firstElementChild: Element | null

Returns the first child that is an element, and null otherwise.

hidden

hidden: boolean

id

id: string

Returns the value of element's id content attribute. Can be set to change it.

innerHTML

innerHTML: string

innerText

innerText: string

inputMode

inputMode: string

isConnected

isConnected: boolean

Returns true if node is connected and false otherwise.

isContentEditable

isContentEditable: boolean

lang

lang: string

lastChild

lastChild: ChildNode | null

Returns the last child.

lastElementChild

lastElementChild: Element | null

Returns the last child that is an element, and null otherwise.

localName

localName: string

Returns the local name.

namespaceURI

namespaceURI: string | null

Returns the namespace.

nextElementSibling

nextElementSibling: Element | null

Returns the first following sibling that is an element, and null otherwise.

nextSibling

nextSibling: Node | null

Returns the next sibling.

nodeName

nodeName: string

Returns a string appropriate for the type of node, as follows: Element Its HTML-uppercased qualified name. Attr Its qualified name. Text "#text". CDATASection "#cdata-section". ProcessingInstruction Its target. Comment "#comment". Document "#document". DocumentType Its name. DocumentFragment "#document-fragment".

nodeType

nodeType: number

nodeValue

nodeValue: string | null

nonce

nonce: string

offsetHeight

offsetHeight: number

offsetLeft

offsetLeft: number

offsetParent

offsetParent: Element | null

offsetTop

offsetTop: number

offsetWidth

offsetWidth: number

onabort

onabort: function | null

Fires when the user aborts the download.

param

The event.

onanimationcancel

onanimationcancel: function | null

onanimationend

onanimationend: function | null

onanimationiteration

onanimationiteration: function | null

onanimationstart

onanimationstart: function | null

onauxclick

onauxclick: function | null

onblur

onblur: function | null

Fires when the object loses the input focus.

param

The focus event.

oncancel

oncancel: function | null

oncanplay

oncanplay: function | null

Occurs when playback is possible, but would require further buffering.

param

The event.

oncanplaythrough

oncanplaythrough: function | null

onchange

onchange: function | null

Fires when the contents of the object or selection have changed.

param

The event.

onclick

onclick: function | null

Fires when the user clicks the left mouse button on the object

param

The mouse event.

onclose

onclose: function | null

oncontextmenu

oncontextmenu: function | null

Fires when the user clicks the right mouse button in the client area, opening the context menu.

param

The mouse event.

oncopy

oncopy: function | null

oncuechange

oncuechange: function | null

oncut

oncut: function | null

ondblclick

ondblclick: function | null

Fires when the user double-clicks the object.

param

The mouse event.

ondrag

ondrag: function | null

Fires on the source object continuously during a drag operation.

param

The event.

ondragend

ondragend: function | null

Fires on the source object when the user releases the mouse at the close of a drag operation.

param

The event.

ondragenter

ondragenter: function | null

Fires on the target element when the user drags the object to a valid drop target.

param

The drag event.

ondragexit

ondragexit: function | null

ondragleave

ondragleave: function | null

Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.

param

The drag event.

ondragover

ondragover: function | null

Fires on the target element continuously while the user drags the object over a valid drop target.

param

The event.

ondragstart

ondragstart: function | null

Fires on the source object when the user starts to drag a text selection or selected object.

param

The event.

ondrop

ondrop: function | null

ondurationchange

ondurationchange: function | null

Occurs when the duration attribute is updated.

param

The event.

onemptied

onemptied: function | null

Occurs when the media element is reset to its initial state.

param

The event.

onended

onended: function | null

Occurs when the end of playback is reached.

param

The event

onerror

onerror: ErrorEventHandler

Fires when an error occurs during object loading.

param

The event.

onfocus

onfocus: function | null

Fires when the object receives focus.

param

The event.

onfullscreenchange

onfullscreenchange: function | null

onfullscreenerror

onfullscreenerror: function | null

ongotpointercapture

ongotpointercapture: function | null

oninput

oninput: function | null

oninvalid

oninvalid: function | null

onkeydown

onkeydown: function | null

Fires when the user presses a key.

param

The keyboard event

onkeypress

onkeypress: function | null

Fires when the user presses an alphanumeric key.

param

The event.

onkeyup

onkeyup: function | null

Fires when the user releases a key.

param

The keyboard event

onload

onload: function | null

Fires immediately after the browser loads the object.

param

The event.

onloadeddata

onloadeddata: function | null

Occurs when media data is loaded at the current playback position.

param

The event.

onloadedmetadata

onloadedmetadata: function | null

Occurs when the duration and dimensions of the media have been determined.

param

The event.

onloadend

onloadend: function | null

onloadstart

onloadstart: function | null

Occurs when Internet Explorer begins looking for media data.

param

The event.

onlostpointercapture

onlostpointercapture: function | null

onmousedown

onmousedown: function | null

Fires when the user clicks the object with either mouse button.

param

The mouse event.

onmouseenter

onmouseenter: function | null

onmouseleave

onmouseleave: function | null

onmousemove

onmousemove: function | null

Fires when the user moves the mouse over the object.

param

The mouse event.

onmouseout

onmouseout: function | null

Fires when the user moves the mouse pointer outside the boundaries of the object.

param

The mouse event.

onmouseover

onmouseover: function | null

Fires when the user moves the mouse pointer into the object.

param

The mouse event.

onmouseup

onmouseup: function | null

Fires when the user releases a mouse button while the mouse is over the object.

param

The mouse event.

onpaste

onpaste: function | null

onpause

onpause: function | null

Occurs when playback is paused.

param

The event.

onplay

onplay: function | null

Occurs when the play method is requested.

param

The event.

onplaying

onplaying: function | null

Occurs when the audio or video has started playing.

param

The event.

onpointercancel

onpointercancel: function | null

onpointerdown

onpointerdown: function | null

onpointerenter

onpointerenter: function | null

onpointerleave

onpointerleave: function | null

onpointermove

onpointermove: function | null

onpointerout

onpointerout: function | null

onpointerover

onpointerover: function | null

onpointerup

onpointerup: function | null

onprogress

onprogress: function | null

Occurs to indicate progress while downloading media data.

param

The event.

onratechange

onratechange: function | null

Occurs when the playback rate is increased or decreased.

param

The event.

onreset

onreset: function | null

Fires when the user resets a form.

param

The event.

onresize

onresize: function | null

onscroll

onscroll: function | null

Fires when the user repositions the scroll box in the scroll bar on the object.

param

The event.

onsecuritypolicyviolation

onsecuritypolicyviolation: function | null

onseeked

onseeked: function | null

Occurs when the seek operation ends.

param

The event.

onseeking

onseeking: function | null

Occurs when the current playback position is moved.

param

The event.

onselect

onselect: function | null

Fires when the current selection changes.

param

The event.

onstalled

onstalled: function | null

Occurs when the download has stopped.

param

The event.

onsubmit

onsubmit: function | null

onsuspend

onsuspend: function | null

Occurs if the load operation has been intentionally halted.

param

The event.

ontimeupdate

ontimeupdate: function | null

Occurs to indicate the current playback position.

param

The event.

ontoggle

ontoggle: function | null

ontouchcancel

ontouchcancel: function | null

ontouchend

ontouchend: function | null

ontouchmove

ontouchmove: function | null

ontouchstart

ontouchstart: function | null

ontransitioncancel

ontransitioncancel: function | null

ontransitionend

ontransitionend: function | null

ontransitionrun

ontransitionrun: function | null

ontransitionstart

ontransitionstart: function | null

onvolumechange

onvolumechange: function | null

Occurs when the volume is changed, or playback is muted or unmuted.

param

The event.

onwaiting

onwaiting: function | null

Occurs when playback stops because the next frame of a video resource is not available.

param

The event.

onwheel

onwheel: function | null

outerHTML

outerHTML: string

ownerDocument

ownerDocument: Document | null

Returns the node document. Returns null for documents.

parentElement

parentElement: HTMLElement | null

Returns the parent element.

parentNode

parentNode: Node & ParentNode | null

Returns the parent.

prefix

prefix: string | null

Returns the namespace prefix.

previousElementSibling

previousElementSibling: Element | null

Returns the first preceding sibling that is an element, and null otherwise.

previousSibling

previousSibling: Node | null

Returns the previous sibling.

scrollHeight

scrollHeight: number

scrollLeft

scrollLeft: number

scrollTop

scrollTop: number

scrollWidth

scrollWidth: number

shadowRoot

shadowRoot: ShadowRoot | null

Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.

slot

slot: string

Returns the value of element's slot content attribute. Can be set to change it.

spellcheck

spellcheck: boolean

style

style: CSSStyleDeclaration

tabIndex

tabIndex: number

tagName

tagName: string

Returns the HTML-uppercased qualified name.

textContent

textContent: string | null

translate

translate: boolean

Static htmlTagName

htmlTagName: string = "igc-category-x-axis"

Accessors

actualInterval

  • get actualInterval(): number
  • set actualInterval(v: number): void
  • Gets the effective value for the current Interval.

    let effectiveInterval: number = xAxis.actualInterval;

    Returns number

  • Gets the effective value for the current Interval.

    let effectiveInterval: number = xAxis.actualInterval;

    Parameters

    • v: number

    Returns void

actualIntervalChange

  • get actualIntervalChange(): function
  • set actualIntervalChange(ev: function): void

actualMajorStroke

  • get actualMajorStroke(): string
  • set actualMajorStroke(v: string): void
  • Gets or sets the ActualMajorStroke property.

    The actualMajorStroke property is used for ActualMajorStroke of the axis.

    Returns string

  • Gets or sets the ActualMajorStroke property.

    The actualMajorStroke property is used for ActualMajorStroke of the axis.

    Parameters

    • v: string

    Returns void

actualMinorInterval

  • get actualMinorInterval(): number
  • set actualMinorInterval(v: number): void
  • Gets the effective value for the current MinorInterval.

    let effectiveMinorInterval: number = xAxis.actualMinorInterval;

    Returns number

  • Gets the effective value for the current MinorInterval.

    let effectiveMinorInterval: number = xAxis.actualMinorInterval;

    Parameters

    • v: number

    Returns void

actualMinorIntervalChange

  • get actualMinorIntervalChange(): function
  • set actualMinorIntervalChange(ev: function): void

actualMinorStroke

  • get actualMinorStroke(): string
  • set actualMinorStroke(v: string): void
  • Gets or sets the ActualMinorStroke property.

    The actualMinorStroke property is used for ActualMinorStroke of the axis.

    Returns string

  • Gets or sets the ActualMinorStroke property.

    The actualMinorStroke property is used for ActualMinorStroke of the axis.

    Parameters

    • v: string

    Returns void

actualStroke

  • get actualStroke(): string
  • set actualStroke(v: string): void
  • Gets or sets the effective stroke used for the axis.

    Returns string

  • Gets or sets the effective stroke used for the axis.

    Parameters

    • v: string

    Returns void

annotations

axisInternal

  • get axisInternal(): Axis

coercionMethods

  • get coercionMethods(): any
  • set coercionMethods(v: any): void
  • Gets or sets the coercion methods to use when loading data from data sources. Should be specified before setting any member paths, if being used. Setting it later will not cause data to be re-imported into the chart.

    The coercionMethods methods is to use when loading data from data sources. Should be specified before setting any member paths, if being used. Setting it later will not cause data to be reimported into the chart.

    Returns any

  • Gets or sets the coercion methods to use when loading data from data sources. Should be specified before setting any member paths, if being used. Setting it later will not cause data to be re-imported into the chart.

    The coercionMethods methods is to use when loading data from data sources. Should be specified before setting any member paths, if being used. Setting it later will not cause data to be reimported into the chart.

    Parameters

    • v: any

    Returns void

crossingAxis

  • Gets or sets the CrossingAxis property.

    The crossingAxis property is used for CrossingAxis .

    Returns IgcAxisComponent

  • Gets or sets the CrossingAxis property.

    The crossingAxis property is used for CrossingAxis .

    Parameters

    Returns void

crossingAxisName

  • get crossingAxisName(): string
  • set crossingAxisName(v: string): void
  • Gets or sets the name to use to resolve crossingAxis from markup.

    Returns string

  • Gets or sets the name to use to resolve crossingAxis from markup.

    Parameters

    • v: string

    Returns void

crossingValue

  • get crossingValue(): any
  • set crossingValue(v: any): void
  • Gets or sets the CrossingValue property.

    The crossingValue property is used for CrossingValue of the axis.

    Returns any

  • Gets or sets the CrossingValue property.

    The crossingValue property is used for CrossingValue of the axis.

    Parameters

    • v: any

    Returns void

dataSource

  • get dataSource(): any
  • set dataSource(value: any): void

enhancedIntervalMinimumCharacters

  • get enhancedIntervalMinimumCharacters(): number
  • set enhancedIntervalMinimumCharacters(v: number): void
  • Gets or sets the mininum desired characters to be displayed for horizontal axes when using advanced label heuristics. -1 will attempt to adjust the interval to precisely fit the horizontal labels.

    The enhancedIntervalMinimumCharacters property is used to set the mininum desired characters to be displayed for horizontal axes when using advanced label heuristics.

    Returns number

  • Gets or sets the mininum desired characters to be displayed for horizontal axes when using advanced label heuristics. -1 will attempt to adjust the interval to precisely fit the horizontal labels.

    The enhancedIntervalMinimumCharacters property is used to set the mininum desired characters to be displayed for horizontal axes when using advanced label heuristics.

    Parameters

    • v: number

    Returns void

expectFunctions

  • get expectFunctions(): boolean
  • set expectFunctions(v: boolean): void
  • Gets or sets whether the series should expect that properties in its items source may be functions that need to be evaluated to yield their value. This defaults to false, as there will be a subtle performance impact to using this feature. This value must be set before assigning an item's source to take effect.

    Returns boolean

  • Gets or sets whether the series should expect that properties in its items source may be functions that need to be evaluated to yield their value. This defaults to false, as there will be a subtle performance impact to using this feature. This value must be set before assigning an item's source to take effect.

    Parameters

    • v: boolean

    Returns void

formatLabel

  • get formatLabel(): function
  • set formatLabel(v: function): void
  • Sets or gets a function which takes an object that produces a formatted label for displaying in the chart.

    The formatLabel function takes an object that produces a formatted label for displaying in the chart.

    Returns function

      • (item: any): string
      • Parameters

        • item: any

        Returns string

  • Sets or gets a function which takes an object that produces a formatted label for displaying in the chart.

    The formatLabel function takes an object that produces a formatted label for displaying in the chart.

    Parameters

    • v: function
        • (item: any): string
        • Parameters

          • item: any

          Returns string

    Returns void

gap

  • get gap(): number
  • set gap(v: number): void
  • Gets or sets the amount of space between adjacent categories for the current axis object. The gap is silently clamped to the range [0, 1] when used.

    Use the gap property to configure the spacing between items on a category axis with item spacing.

    A gap of 0 allocates no space between items. A gap of 1 allocates a space between items equal to the width of one item.

    To set the item spacing to 75% the width of one item, set the gap to 0.75, as in this code:

    Returns number

  • Gets or sets the amount of space between adjacent categories for the current axis object. The gap is silently clamped to the range [0, 1] when used.

    Use the gap property to configure the spacing between items on a category axis with item spacing.

    A gap of 0 allocates no space between items. A gap of 1 allocates a space between items equal to the width of one item.

    To set the item spacing to 75% the width of one item, set the gap to 0.75, as in this code:

    Parameters

    • v: number

    Returns void

interval

  • get interval(): number
  • set interval(v: number): void
  • Gets or sets the frequency of displayed labels. The set value is a factor that determines which labels will be hidden. For example, an interval of 2 will display every other label.

    interval determines how often to show a label, tickmark, and/or gridline along the x-axis. Set this property to n_ to display a label every _nth item.

    Returns number

  • Gets or sets the frequency of displayed labels. The set value is a factor that determines which labels will be hidden. For example, an interval of 2 will display every other label.

    interval determines how often to show a label, tickmark, and/or gridline along the x-axis. Set this property to n_ to display a label every _nth item.

    Parameters

    • v: number

    Returns void

isAngular

  • get isAngular(): boolean
  • Gets if the current axis is of angular axis type

    Returns boolean

isCategory

  • get isCategory(): boolean

isCategoryDateTime

  • get isCategoryDateTime(): boolean
  • Gets if the current axis is of category date time axis type

    Returns boolean

isContinuous

  • get isContinuous(): boolean

isDateTime

  • get isDateTime(): boolean
  • Gets or sets if the current axis is of date time axis type

    Returns boolean

isDisabled

  • get isDisabled(): boolean
  • set isDisabled(v: boolean): void
  • Gets or sets the IsDisabled property. If true, the axis will not be rendered.

    The isDisabled property is used to decide if the axis will not be rendered.

    Returns boolean

  • Gets or sets the IsDisabled property. If true, the axis will not be rendered.

    The isDisabled property is used to decide if the axis will not be rendered.

    Parameters

    • v: boolean

    Returns void

isInverted

  • get isInverted(): boolean
  • set isInverted(v: boolean): void
  • Gets or sets the IsInverted property.

    Gets or sets the isInverted property.

    Returns boolean

  • Gets or sets the IsInverted property.

    Gets or sets the isInverted property.

    Parameters

    • v: boolean

    Returns void

isNumeric

  • get isNumeric(): boolean
  • Gets or sets if the current axis is of numeric axis type

    Gets or sets if the current axis is of numeric axis type

    Returns boolean

isPiecewise

  • get isPiecewise(): boolean
  • Gets or sets if the axis is a piecewise scaling function.

    Returns boolean

isRadial

  • get isRadial(): boolean
  • Gets or sets if the current axis is of radial axis type

    Returns boolean

isSorting

  • get isSorting(): boolean
  • Gets or sets if the current axis is sorting data items

    Returns boolean

isVertical

  • get isVertical(): boolean
  • Gets if the current axis is a vertical axis.

    Returns boolean

itemsCount

  • get itemsCount(): number
  • set itemsCount(v: number): void
  • Gets the number of items in the current category axis items source.

    Returns number

  • Gets the number of items in the current category axis items source.

    Parameters

    • v: number

    Returns void

label

  • get label(): any
  • set label(v: any): void
  • Gets or sets the axis label format string.

    The label property is used for label mapping of the axis labels.

    Returns any

  • Gets or sets the axis label format string.

    The label property is used for label mapping of the axis labels.

    Parameters

    • v: any

    Returns void

labelAngle

  • get labelAngle(): number
  • set labelAngle(v: number): void
  • Gets or sets the angle of the {0}.

    The Angle property is used to set the angle of the axis.

    Returns number

  • Gets or sets the angle of the {0}.

    The Angle property is used to set the angle of the axis.

    Parameters

    • v: number

    Returns void

labelBottomMargin

  • get labelBottomMargin(): number
  • set labelBottomMargin(v: number): void
  • Margin applied below the {0}.

    The labelBottomMargin is used to set the bottom margin of the labels.

    Returns number

  • Margin applied below the {0}.

    The labelBottomMargin is used to set the bottom margin of the labels.

    Parameters

    • v: number

    Returns void

labelExtent

  • get labelExtent(): number
  • set labelExtent(v: number): void
  • Distance between the axis and the edge of the control.

    The Extent property is used for the extent.

    Returns number

  • Distance between the axis and the edge of the control.

    The Extent property is used for the extent.

    Parameters

    • v: number

    Returns void

labelFormat

  • get labelFormat(): string
  • set labelFormat(v: string): void
  • Gets or sets the label format string to use for the label.

    Returns string

  • Gets or sets the label format string to use for the label.

    Parameters

    • v: string

    Returns void

labelFormatSpecifiers

  • get labelFormatSpecifiers(): any[]
  • set labelFormatSpecifiers(v: any[]): void
  • Gets or sets the format specifiers to use with the LabelFormat string.

    Returns any[]

  • Gets or sets the format specifiers to use with the LabelFormat string.

    Parameters

    • v: any[]

    Returns void

labelHorizontalAlignment

  • get labelHorizontalAlignment(): HorizontalAlignment
  • set labelHorizontalAlignment(v: HorizontalAlignment): void
  • Gets or sets the horizontal alignment of the {0}.

    The HorizontalAlignment property is used for the horizontal alignment.

    Returns HorizontalAlignment

  • Gets or sets the horizontal alignment of the {0}.

    The HorizontalAlignment property is used for the horizontal alignment.

    Parameters

    • v: HorizontalAlignment

    Returns void

labelLeftMargin

  • get labelLeftMargin(): number
  • set labelLeftMargin(v: number): void
  • Margin applied to the left of the {0}.

    The labelLeftMargin property is used for the left margin of the labels.

    Returns number

  • Margin applied to the left of the {0}.

    The labelLeftMargin property is used for the left margin of the labels.

    Parameters

    • v: number

    Returns void

labelLocation

labelRightMargin

  • get labelRightMargin(): number
  • set labelRightMargin(v: number): void
  • Margin applied to the right of the {0}.

    The labelRightMargin property is used for the right margin of the labels.

    Returns number

  • Margin applied to the right of the {0}.

    The labelRightMargin property is used for the right margin of the labels.

    Parameters

    • v: number

    Returns void

labelShowFirstLabel

  • get labelShowFirstLabel(): boolean
  • set labelShowFirstLabel(v: boolean): void
  • Gets or sets whether the first label is displayed when the zoom level is set to 1.

    The ShowFirstLabel is used to check whether the first label is displayed when the zoom level is set to 1.

    Returns boolean

  • Gets or sets whether the first label is displayed when the zoom level is set to 1.

    The ShowFirstLabel is used to check whether the first label is displayed when the zoom level is set to 1.

    Parameters

    • v: boolean

    Returns void

labelTextColor

  • get labelTextColor(): string
  • set labelTextColor(v: string): void
  • The color of the {0}.

    The labelTextColor property Overrides the color of the text used for the axis labels.

    Returns string

  • The color of the {0}.

    The labelTextColor property Overrides the color of the text used for the axis labels.

    Parameters

    • v: string

    Returns void

labelTextStyle

  • get labelTextStyle(): string
  • set labelTextStyle(v: string): void
  • Gets or sets the text style to use for axis labels.

    The labelTextStyle property Overrides the style of the text used for the axis labels.

    Returns string

  • Gets or sets the text style to use for axis labels.

    The labelTextStyle property Overrides the style of the text used for the axis labels.

    Parameters

    • v: string

    Returns void

labelTopMargin

  • get labelTopMargin(): number
  • set labelTopMargin(v: number): void
  • Margin applied above the {0}.

    The labelTopMargin property is used for the top margin of the labels.

    Returns number

  • Margin applied above the {0}.

    The labelTopMargin property is used for the top margin of the labels.

    Parameters

    • v: number

    Returns void

labelVerticalAlignment

  • get labelVerticalAlignment(): VerticalAlignment
  • set labelVerticalAlignment(v: VerticalAlignment): void
  • Gets or sets the vertical alignment of the {0}.

    The VerticalAlignment property is used for the vertical alignment of the axis.

    Returns VerticalAlignment

  • Gets or sets the vertical alignment of the {0}.

    The VerticalAlignment property is used for the vertical alignment of the axis.

    Parameters

    • v: VerticalAlignment

    Returns void

labelVisibility

  • get labelVisibility(): Visibility
  • set labelVisibility(v: Visibility): void
  • Gets or sets the visibility of the {0}.

    The Visibility property is used for the visibility of the axis.

    Returns Visibility

  • Gets or sets the visibility of the {0}.

    The Visibility property is used for the visibility of the axis.

    Parameters

    • v: Visibility

    Returns void

majorStroke

  • get majorStroke(): string
  • set majorStroke(v: string): void
  • Gets or sets the MajorStroke property. Null is treated as auto. Major lines will be displayed or not based on the axis type and series used with it.

    Gets or sets the majorStroke using this property.

    Returns string

  • Gets or sets the MajorStroke property. Null is treated as auto. Major lines will be displayed or not based on the axis type and series used with it.

    Gets or sets the majorStroke using this property.

    Parameters

    • v: string

    Returns void

majorStrokeThickness

  • get majorStrokeThickness(): number
  • set majorStrokeThickness(v: number): void
  • Gets or sets the MajorStrokeThickness property.

    Gets or sets the majorStrokeThickness using this property.

    Returns number

  • Gets or sets the MajorStrokeThickness property.

    Gets or sets the majorStrokeThickness using this property.

    Parameters

    • v: number

    Returns void

minorInterval

  • get minorInterval(): number
  • set minorInterval(v: number): void
  • Gets or sets the frequency of displayed minor lines. The set value is a factor that determines how the minor lines will be displayed.

    minorInterval determines how often to show a minor gridline along the x-axis. This property is relevant only when the displayed series is a type with grouping, like column series.

    minorInterval is expressed as a number between 0 and 1, representing the frequency of the interval. To display minor gridlines representing 10ths of an item width, set minorInterval to 0.1.

    Returns number

  • Gets or sets the frequency of displayed minor lines. The set value is a factor that determines how the minor lines will be displayed.

    minorInterval determines how often to show a minor gridline along the x-axis. This property is relevant only when the displayed series is a type with grouping, like column series.

    minorInterval is expressed as a number between 0 and 1, representing the frequency of the interval. To display minor gridlines representing 10ths of an item width, set minorInterval to 0.1.

    Parameters

    • v: number

    Returns void

minorStroke

  • get minorStroke(): string
  • set minorStroke(v: string): void
  • Gets or sets the MinorStroke property.

    Gets or sets the minorStroke thickness using minorStrokeThickness property.

    Returns string

  • Gets or sets the MinorStroke property.

    Gets or sets the minorStroke thickness using minorStrokeThickness property.

    Parameters

    • v: string

    Returns void

minorStrokeThickness

  • get minorStrokeThickness(): number
  • set minorStrokeThickness(v: number): void
  • Gets or sets the MinorStrokeThickness property.

    Returns number

  • Gets or sets the MinorStrokeThickness property.

    Parameters

    • v: number

    Returns void

name

  • get name(): string
  • set name(value: string): void
  • Returns string

  • Parameters

    • value: string

    Returns void

overlap

  • get overlap(): number
  • set overlap(v: number): void
  • Gets or sets the amount of overlap between adjacent categories for the current axis object. The overlap is silently clamped to the range [-1, 1] when used.

    Use the overlap property to configure the spacing between items on a category axis with item spacing and more than one series.

    An overlap of 0 places grouped items adjacent to each other. An overlap of 1 places grouped items in the same axis space, completely overlapping. An overlap of -1 places a space between grouped items equal to the width of one item.

    To place grouped items with 75% overlap, set the overlap to 0.75, as in this code:

    Returns number

  • Gets or sets the amount of overlap between adjacent categories for the current axis object. The overlap is silently clamped to the range [-1, 1] when used.

    Use the overlap property to configure the spacing between items on a category axis with item spacing and more than one series.

    An overlap of 0 places grouped items adjacent to each other. An overlap of 1 places grouped items in the same axis space, completely overlapping. An overlap of -1 places a space between grouped items equal to the width of one item.

    To place grouped items with 75% overlap, set the overlap to 0.75, as in this code:

    Parameters

    • v: number

    Returns void

rangeChanged

  • get rangeChanged(): function
  • set rangeChanged(ev: function): void

renderRequested

  • get renderRequested(): function
  • set renderRequested(ev: function): void

strip

  • get strip(): string
  • set strip(v: string): void
  • Gets or sets the Strip property.

    Use strip property to set the strip of the chart.

    Returns string

  • Gets or sets the Strip property.

    Use strip property to set the strip of the chart.

    Parameters

    • v: string

    Returns void

stroke

  • get stroke(): string
  • set stroke(v: string): void
  • Gets or sets the Stroke property. Null is treated as auto. The axis stroke will be displayed or not based on the axis type and series used with it.

    Use stroke property to set the stroke of the chart.

    Returns string

  • Gets or sets the Stroke property. Null is treated as auto. The axis stroke will be displayed or not based on the axis type and series used with it.

    Use stroke property to set the stroke of the chart.

    Parameters

    • v: string

    Returns void

strokeThickness

  • get strokeThickness(): number
  • set strokeThickness(v: number): void
  • Gets or sets the StrokeThickness property.

    Use strokeThickness property for the thickness of the stroke.

    Returns number

  • Gets or sets the StrokeThickness property.

    Use strokeThickness property for the thickness of the stroke.

    Parameters

    • v: number

    Returns void

tickLength

  • get tickLength(): number
  • set tickLength(v: number): void
  • Gets or sets the TickLength property.

    Use tickLength property for The length of the tickmarks to display for this axis.

    Returns number

  • Gets or sets the TickLength property.

    Use tickLength property for The length of the tickmarks to display for this axis.

    Parameters

    • v: number

    Returns void

tickStroke

  • get tickStroke(): string
  • set tickStroke(v: string): void
  • Gets or sets the TickStroke property.

    Use tickStroke property for the color of the tickmarks.

    Returns string

  • Gets or sets the TickStroke property.

    Use tickStroke property for the color of the tickmarks.

    Parameters

    • v: string

    Returns void

tickStrokeThickness

  • get tickStrokeThickness(): number
  • set tickStrokeThickness(v: number): void
  • Gets or sets the TickStrokeThickness property.

    Use tickStrokeThickness property for thickness of the stroke tickmarks.

    Returns number

  • Gets or sets the TickStrokeThickness property.

    Use tickStrokeThickness property for thickness of the stroke tickmarks.

    Parameters

    • v: number

    Returns void

title

  • get title(): string
  • set title(v: string): void
  • Gets or sets the Title property.

    Use title property to display the title of the component.

    Returns string

  • Gets or sets the Title property.

    Use title property to display the title of the component.

    Parameters

    • v: string

    Returns void

titleAngle

  • get titleAngle(): number
  • set titleAngle(v: number): void
  • Gets or sets the angle of the {0}.

    The Angle property is used to set the angle of the axis.

    Returns number

  • Gets or sets the angle of the {0}.

    The Angle property is used to set the angle of the axis.

    Parameters

    • v: number

    Returns void

titleBottomMargin

  • get titleBottomMargin(): number
  • set titleBottomMargin(v: number): void
  • Margin applied below the {0}.

    The labelBottomMargin is used to set the bottom margin of the labels.

    Returns number

  • Margin applied below the {0}.

    The labelBottomMargin is used to set the bottom margin of the labels.

    Parameters

    • v: number

    Returns void

titleExtent

  • get titleExtent(): number
  • set titleExtent(v: number): void
  • Distance between the axis and the edge of the control.

    The Extent property is used for the extent.

    Returns number

  • Distance between the axis and the edge of the control.

    The Extent property is used for the extent.

    Parameters

    • v: number

    Returns void

titleHorizontalAlignment

  • get titleHorizontalAlignment(): HorizontalAlignment
  • set titleHorizontalAlignment(v: HorizontalAlignment): void
  • Gets or sets the horizontal alignment of the {0}.

    The HorizontalAlignment property is used for the horizontal alignment.

    Returns HorizontalAlignment

  • Gets or sets the horizontal alignment of the {0}.

    The HorizontalAlignment property is used for the horizontal alignment.

    Parameters

    • v: HorizontalAlignment

    Returns void

titleLeftMargin

  • get titleLeftMargin(): number
  • set titleLeftMargin(v: number): void
  • Margin applied to the left of the {0}.

    The labelLeftMargin property is used for the left margin of the labels.

    Returns number

  • Margin applied to the left of the {0}.

    The labelLeftMargin property is used for the left margin of the labels.

    Parameters

    • v: number

    Returns void

titleLocation

titlePosition

titleRightMargin

  • get titleRightMargin(): number
  • set titleRightMargin(v: number): void
  • Margin applied to the right of the {0}.

    The labelRightMargin property is used for the right margin of the labels.

    Returns number

  • Margin applied to the right of the {0}.

    The labelRightMargin property is used for the right margin of the labels.

    Parameters

    • v: number

    Returns void

titleShowFirstLabel

  • get titleShowFirstLabel(): boolean
  • set titleShowFirstLabel(v: boolean): void
  • Gets or sets whether the first label is displayed when the zoom level is set to 1.

    The ShowFirstLabel is used to check whether the first label is displayed when the zoom level is set to 1.

    Returns boolean

  • Gets or sets whether the first label is displayed when the zoom level is set to 1.

    The ShowFirstLabel is used to check whether the first label is displayed when the zoom level is set to 1.

    Parameters

    • v: boolean

    Returns void

titleTextColor

  • get titleTextColor(): string
  • set titleTextColor(v: string): void
  • The color of the {0}.

    The labelTextColor property Overrides the color of the text used for the axis labels.

    Returns string

  • The color of the {0}.

    The labelTextColor property Overrides the color of the text used for the axis labels.

    Parameters

    • v: string

    Returns void

titleTextStyle

  • get titleTextStyle(): string
  • set titleTextStyle(v: string): void
  • Gets or sets the text style to use for axis labels.

    The labelTextStyle property Overrides the style of the text used for the axis labels.

    Returns string

  • Gets or sets the text style to use for axis labels.

    The labelTextStyle property Overrides the style of the text used for the axis labels.

    Parameters

    • v: string

    Returns void

titleTopMargin

  • get titleTopMargin(): number
  • set titleTopMargin(v: number): void
  • Margin applied above the {0}.

    The labelTopMargin property is used for the top margin of the labels.

    Returns number

  • Margin applied above the {0}.

    The labelTopMargin property is used for the top margin of the labels.

    Parameters

    • v: number

    Returns void

titleVerticalAlignment

  • get titleVerticalAlignment(): VerticalAlignment
  • set titleVerticalAlignment(v: VerticalAlignment): void
  • Gets or sets the vertical alignment of the {0}.

    The VerticalAlignment property is used for the vertical alignment of the axis.

    Returns VerticalAlignment

  • Gets or sets the vertical alignment of the {0}.

    The VerticalAlignment property is used for the vertical alignment of the axis.

    Parameters

    • v: VerticalAlignment

    Returns void

titleVisibility

  • get titleVisibility(): Visibility
  • set titleVisibility(v: Visibility): void
  • Gets or sets the visibility of the {0}.

    The Visibility property is used for the visibility of the axis.

    Returns Visibility

  • Gets or sets the visibility of the {0}.

    The Visibility property is used for the visibility of the axis.

    Parameters

    • v: Visibility

    Returns void

useClusteringMode

  • get useClusteringMode(): boolean
  • set useClusteringMode(v: boolean): void
  • Gets or sets whether the category axis should use clustering display mode even if no series are present that would force clustering mode.

    useClusteringMode applies grouping and spacing to a category axis equivalent to the grouping that occurs when grouping series, such as ColumnSeries, are used.

    Try setting it on an axis displaying financial series to adjust the spacing on the left and right sides of the axis:

    Returns boolean

  • Gets or sets whether the category axis should use clustering display mode even if no series are present that would force clustering mode.

    useClusteringMode applies grouping and spacing to a category axis equivalent to the grouping that occurs when grouping series, such as ColumnSeries, are used.

    Try setting it on an axis displaying financial series to adjust the spacing on the left and right sides of the axis:

    Parameters

    • v: boolean

    Returns void

useEnhancedIntervalManagement

  • get useEnhancedIntervalManagement(): boolean
  • set useEnhancedIntervalManagement(v: boolean): void
  • Gets or sets whether to use more advanced heuristics when determining the initial number of labels to render, before resolving collisions, etc.

    Use useEnhancedIntervalManagement property to gets/sets whether to use more advanced heuristics when determining the initial number of labels to render, before resolving collisions, etc.

    Returns boolean

  • Gets or sets whether to use more advanced heuristics when determining the initial number of labels to render, before resolving collisions, etc.

    Use useEnhancedIntervalManagement property to gets/sets whether to use more advanced heuristics when determining the initial number of labels to render, before resolving collisions, etc.

    Parameters

    • v: boolean

    Returns void

Static observedAttributes

  • get observedAttributes(): string[]

Methods

addEventListener

  • addEventListener<K>(type: K, listener: function, options?: boolean | AddEventListenerOptions): void
  • addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void
  • Type parameters

    • K: keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: function
        • (this: HTMLElement, ev: HTMLElementEventMap[K]): any
        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

after

  • after(...nodes: (string | Node)[]): void
  • Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes. Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

animate

  • animate(keyframes: Keyframe[] | PropertyIndexedKeyframes | null, options?: number | KeyframeAnimationOptions): Animation
  • Parameters

    • keyframes: Keyframe[] | PropertyIndexedKeyframes | null
    • Optional options: number | KeyframeAnimationOptions

    Returns Animation

append

  • append(...nodes: (string | Node)[]): void
  • Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes. Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

appendChild

  • appendChild<T>(newChild: T): T
  • Type parameters

    • T: Node

    Parameters

    • newChild: T

    Returns T

attachShadow

  • attachShadow(shadowRootInitDict: ShadowRootInit): ShadowRoot
  • Creates a shadow root for element and returns it.

    Parameters

    • shadowRootInitDict: ShadowRootInit

    Returns ShadowRoot

attributeChangedCallback

  • attributeChangedCallback(name: string, oldValue: string, newValue: string): void

before

  • before(...nodes: (string | Node)[]): void
  • Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes. Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

bindAxes

blur

  • blur(): void
  • Returns void

click

  • click(): void
  • Returns void

cloneNode

  • cloneNode(deep?: boolean): Node
  • Returns a copy of node. If deep is true, the copy also includes the node's descendants.

    Parameters

    • Optional deep: boolean

    Returns Node

closest

  • closest<K>(selector: K): HTMLElementTagNameMap[K] | null
  • closest<K>(selector: K): SVGElementTagNameMap[K] | null
  • closest(selector: string): Element | null
  • Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.

    Type parameters

    • K: keyof HTMLElementTagNameMap

    Parameters

    • selector: K

    Returns HTMLElementTagNameMap[K] | null

  • Type parameters

    • K: keyof SVGElementTagNameMap

    Parameters

    • selector: K

    Returns SVGElementTagNameMap[K] | null

  • Parameters

    • selector: string

    Returns Element | null

compareDocumentPosition

  • compareDocumentPosition(other: Node): number
  • Parameters

    • other: Node

    Returns number

connectedCallback

  • connectedCallback(): void

contains

  • contains(other: Node | null): boolean
  • Returns true if other is an inclusive descendant of node, and false otherwise.

    Parameters

    • other: Node | null

    Returns boolean

dispatchEvent

  • dispatchEvent(event: Event): boolean
  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    • event: Event

    Returns boolean

ensureLabelSettings

  • ensureLabelSettings(): void

ensureTitleSettings

  • ensureTitleSettings(): void

findByName

  • findByName(name: string): any
  • Parameters

    • name: string

    Returns any

focus

  • focus(options?: FocusOptions): void
  • Parameters

    • Optional options: FocusOptions

    Returns void

getAnimations

  • getAnimations(): Animation[]
  • Returns Animation[]

getAttribute

  • getAttribute(qualifiedName: string): string | null
  • Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.

    Parameters

    • qualifiedName: string

    Returns string | null

getAttributeNS

  • getAttributeNS(namespace: string | null, localName: string): string | null
  • Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.

    Parameters

    • namespace: string | null
    • localName: string

    Returns string | null

getAttributeNames

  • getAttributeNames(): string[]
  • Returns the qualified names of all element's attributes. Can contain duplicates.

    Returns string[]

getAttributeNode

  • getAttributeNode(name: string): Attr | null
  • Parameters

    • name: string

    Returns Attr | null

getAttributeNodeNS

  • getAttributeNodeNS(namespaceURI: string, localName: string): Attr | null
  • Parameters

    • namespaceURI: string
    • localName: string

    Returns Attr | null

getBoundingClientRect

  • getBoundingClientRect(): ClientRect | DOMRect
  • Returns ClientRect | DOMRect

getCategoryBoundingBox

  • getCategoryBoundingBox(point: IgPoint, useInterpolation: boolean, singularWidth: number): IgRect

getCategoryBoundingBoxHelper

  • getCategoryBoundingBoxHelper(point: IgPoint, useInterpolation: boolean, singularWidth: number, isVertical: boolean): IgRect

getClientRects

  • getClientRects(): ClientRectList | DOMRectList
  • Returns ClientRectList | DOMRectList

getElementsByClassName

  • getElementsByClassName(classNames: string): HTMLCollectionOf<Element>
  • Parameters

    • classNames: string

    Returns HTMLCollectionOf<Element>

getElementsByTagName

  • getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<HTMLElementTagNameMap[K]>
  • getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<SVGElementTagNameMap[K]>
  • getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>
  • Type parameters

    • K: keyof HTMLElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>

  • Type parameters

    • K: keyof SVGElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<SVGElementTagNameMap[K]>

  • Parameters

    • qualifiedName: string

    Returns HTMLCollectionOf<Element>

getElementsByTagNameNS

  • getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>
  • getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>
  • getElementsByTagNameNS(namespaceURI: string, localName: string): HTMLCollectionOf<Element>
  • Parameters

    • namespaceURI: "http://www.w3.org/1999/xhtml"
    • localName: string

    Returns HTMLCollectionOf<HTMLElement>

  • Parameters

    • namespaceURI: "http://www.w3.org/2000/svg"
    • localName: string

    Returns HTMLCollectionOf<SVGElement>

  • Parameters

    • namespaceURI: string
    • localName: string

    Returns HTMLCollectionOf<Element>

getItemValue

  • getItemValue(item: any, memberPathName: string): any
  • Parameters

    • item: any
    • memberPathName: string

    Returns any

getRootNode

  • getRootNode(options?: GetRootNodeOptions): Node
  • Returns node's shadow-including root.

    Parameters

    • Optional options: GetRootNodeOptions

    Returns Node

getValueLabel

  • getValueLabel(value: number): string
  • Gets the label for a data item.

    Parameters

    • value: number
      • The unscaled value to get a label for.

    Returns string

hasAttribute

  • hasAttribute(qualifiedName: string): boolean
  • Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.

    Parameters

    • qualifiedName: string

    Returns boolean

hasAttributeNS

  • hasAttributeNS(namespace: string | null, localName: string): boolean
  • Returns true if element has an attribute whose namespace is namespace and local name is localName.

    Parameters

    • namespace: string | null
    • localName: string

    Returns boolean

hasAttributes

  • hasAttributes(): boolean
  • Returns true if element has attributes, and false otherwise.

    Returns boolean

hasChildNodes

  • hasChildNodes(): boolean
  • Returns whether node has children.

    Returns boolean

hasPointerCapture

  • hasPointerCapture(pointerId: number): boolean
  • Parameters

    • pointerId: number

    Returns boolean

insertAdjacentElement

  • insertAdjacentElement(position: InsertPosition, insertedElement: Element): Element | null
  • Parameters

    • position: InsertPosition
    • insertedElement: Element

    Returns Element | null

insertAdjacentHTML

  • insertAdjacentHTML(where: InsertPosition, html: string): void
  • Parameters

    • where: InsertPosition
    • html: string

    Returns void

insertAdjacentText

  • insertAdjacentText(where: InsertPosition, text: string): void
  • Parameters

    • where: InsertPosition
    • text: string

    Returns void

insertBefore

  • insertBefore<T>(newChild: T, refChild: Node | null): T
  • Type parameters

    • T: Node

    Parameters

    • newChild: T
    • refChild: Node | null

    Returns T

isDefaultNamespace

  • isDefaultNamespace(namespace: string | null): boolean
  • Parameters

    • namespace: string | null

    Returns boolean

isEqualNode

  • isEqualNode(otherNode: Node | null): boolean
  • Returns whether node and otherNode have the same properties.

    Parameters

    • otherNode: Node | null

    Returns boolean

isSameNode

  • isSameNode(otherNode: Node | null): boolean
  • Parameters

    • otherNode: Node | null

    Returns boolean

lookupNamespaceURI

  • lookupNamespaceURI(prefix: string | null): string | null
  • Parameters

    • prefix: string | null

    Returns string | null

lookupPrefix

  • lookupPrefix(namespace: string | null): string | null
  • Parameters

    • namespace: string | null

    Returns string | null

matches

  • matches(selectors: string): boolean
  • Returns true if matching selectors against element's root yields element, and false otherwise.

    Parameters

    • selectors: string

    Returns boolean

msGetRegionContent

  • msGetRegionContent(): any
  • Returns any

normalize

  • normalize(): void
  • Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.

    Returns void

notifyClearItems

  • notifyClearItems(): void
  • Used to manually notify the axis that the data source has reset or cleared its items.

    Returns void

notifyInsertItem

  • notifyInsertItem(index: number, newItem: any): void

notifyRemoveItem

  • notifyRemoveItem(index: number, oldItem: any): void

notifySetItem

  • notifySetItem(index: number, oldItem: any, newItem: any): void

prepend

  • prepend(...nodes: (string | Node)[]): void
  • Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes. Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

provideData

  • provideData(data: any[]): void

querySelector

  • querySelector<K>(selectors: K): HTMLElementTagNameMap[K] | null
  • querySelector<K>(selectors: K): SVGElementTagNameMap[K] | null
  • querySelector<E>(selectors: string): E | null
  • Returns the first element that is a descendant of node that matches selectors.

    Type parameters

    • K: keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns HTMLElementTagNameMap[K] | null

  • Type parameters

    • K: keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns SVGElementTagNameMap[K] | null

  • Type parameters

    • E: Element

    Parameters

    • selectors: string

    Returns E | null

querySelectorAll

  • querySelectorAll<K>(selectors: K): NodeListOf<HTMLElementTagNameMap[K]>
  • querySelectorAll<K>(selectors: K): NodeListOf<SVGElementTagNameMap[K]>
  • querySelectorAll<E>(selectors: string): NodeListOf<E>
  • Returns all element descendants of node that match selectors.

    Type parameters

    • K: keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementTagNameMap[K]>

  • Type parameters

    • K: keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<SVGElementTagNameMap[K]>

  • Type parameters

    • E: Element

    Parameters

    • selectors: string

    Returns NodeListOf<E>

releasePointerCapture

  • releasePointerCapture(pointerId: number): void
  • Parameters

    • pointerId: number

    Returns void

remove

  • remove(): void
  • Removes node.

    Returns void

removeAttribute

  • removeAttribute(qualifiedName: string): void
  • Removes element's first attribute whose qualified name is qualifiedName.

    Parameters

    • qualifiedName: string

    Returns void

removeAttributeNS

  • removeAttributeNS(namespace: string | null, localName: string): void
  • Removes element's attribute whose namespace is namespace and local name is localName.

    Parameters

    • namespace: string | null
    • localName: string

    Returns void

removeAttributeNode

  • removeAttributeNode(attr: Attr): Attr
  • Parameters

    • attr: Attr

    Returns Attr

removeChild

  • removeChild<T>(oldChild: T): T
  • Type parameters

    • T: Node

    Parameters

    • oldChild: T

    Returns T

removeEventListener

  • removeEventListener<K>(type: K, listener: function, options?: boolean | EventListenerOptions): void
  • removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void
  • Type parameters

    • K: keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: function
        • (this: HTMLElement, ev: HTMLElementEventMap[K]): any
        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    • Optional options: boolean | EventListenerOptions

    Returns void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

renderAxis

  • renderAxis(): void
  • Renders the axis with no animation.

    Returns void

replaceChild

  • replaceChild<T>(newChild: Node, oldChild: T): T
  • Type parameters

    • T: Node

    Parameters

    • newChild: Node
    • oldChild: T

    Returns T

replaceWith

  • replaceWith(...nodes: (string | Node)[]): void
  • Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes. Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

requestFullscreen

  • requestFullscreen(): Promise<void>
  • Displays element fullscreen and resolves promise when done.

    Returns Promise<void>

resetCachedEnhancedInterval

  • resetCachedEnhancedInterval(): void
  • If using enhanced interval management and precise interval fitting, this will reset the cached maximum label width, and recalculate using the current labels.

    Returns void

scaleValue

  • scaleValue(unscaledValue: number): number
  • Scales a value from axis space into screen space.

    Parameters

    • unscaledValue: number
      • The unscaled axis value to scale.

    Returns number

scroll

  • scroll(options?: ScrollToOptions): void
  • scroll(x: number, y: number): void
  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollBy

  • scrollBy(options?: ScrollToOptions): void
  • scrollBy(x: number, y: number): void
  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollIntoView

  • scrollIntoView(item: any): void
  • Scrolls the specified item into view.

    Parameters

    • item: any
      • Data item to scroll into view

    Returns void

scrollRangeIntoView

  • scrollRangeIntoView(minimum: number, maximum: number): void
  • Parameters

    • minimum: number
    • maximum: number

    Returns void

scrollTo

  • scrollTo(options?: ScrollToOptions): void
  • scrollTo(x: number, y: number): void
  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

setAttribute

  • setAttribute(qualifiedName: string, value: string): void
  • Sets the value of element's first attribute whose qualified name is qualifiedName to value.

    Parameters

    • qualifiedName: string
    • value: string

    Returns void

setAttributeNS

  • setAttributeNS(namespace: string | null, qualifiedName: string, value: string): void
  • Sets the value of element's attribute whose namespace is namespace and local name is localName to value.

    Parameters

    • namespace: string | null
    • qualifiedName: string
    • value: string

    Returns void

setAttributeNode

  • setAttributeNode(attr: Attr): Attr | null
  • Parameters

    • attr: Attr

    Returns Attr | null

setAttributeNodeNS

  • setAttributeNodeNS(attr: Attr): Attr | null
  • Parameters

    • attr: Attr

    Returns Attr | null

setPointerCapture

  • setPointerCapture(pointerId: number): void
  • Parameters

    • pointerId: number

    Returns void

toggleAttribute

  • toggleAttribute(qualifiedName: string, force?: boolean): boolean
  • If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName. Returns true if qualifiedName is now present, and false otherwise.

    Parameters

    • qualifiedName: string
    • Optional force: boolean

    Returns boolean

unscaleValue

  • unscaleValue(unscaledValue: number): number
  • Unscales a value from screen space into axis space.

    Parameters

    • unscaledValue: number
      • The scaled value in screen coordinates to unscale into axis space.

    Returns number

webkitMatchesSelector

  • webkitMatchesSelector(selectors: string): boolean
  • Parameters

    • selectors: string

    Returns boolean

Static _createFromInternal

Static register

  • register(): void
  • Returns void