IIgrAxisProps

Properties

Optional actualMajorStroke

Gets or sets the ActualMajorStroke property.

The ActualMajorStroke property is used for ActualMajorStroke of the axis.

actualMajorStroke?: string

Optional actualMinorStroke

Gets or sets the ActualMinorStroke property.

The ActualMinorStroke property is used for ActualMinorStroke of the axis.

actualMinorStroke?: string

Optional actualStroke

Gets or sets the effective stroke used for the axis.

actualStroke?: string

Optional children

children?: ReactNode

Optional coercionMethods

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.

coercionMethods?: any

Optional companionAxisCrossingAxis

Gets or sets crossing axis for the companion axis.

companionAxisCrossingAxis?: IgrAxis

Optional companionAxisCrossingAxisName

Gets or sets the name to use to resolve companionAxisCrossingAxis from markup.

companionAxisCrossingAxisName?: string

Optional companionAxisCrossingValue

Gets or sets crossing value for the companion axis.

companionAxisCrossingValue?: string | number

Optional companionAxisEnabled

Gets or sets whether or not the companion axis is enabled for this axis.

companionAxisEnabled?: string | boolean

Optional companionAxisIsInverted

Gets or sets whether or not the companion axis is inverted.

companionAxisIsInverted?: any

Optional companionAxisLabelAngle

Gets or sets label angle on the companion axis.

companionAxisLabelAngle?: string | number

Optional companionAxisLabelColor

Gets or sets color of labels on the companion axis.

companionAxisLabelColor?: string

Optional companionAxisLabelExtent

Gets or sets extent of labels on the companion axis.

companionAxisLabelExtent?: string | number

Optional companionAxisLabelHorizontalAlignment

Gets or sets horizontal alignment of labels on the companion axis.

companionAxisLabelHorizontalAlignment?: any

Optional companionAxisLabelLocation

Gets or sets location of labels on the companion axis.

companionAxisLabelLocation?: string | AxisLabelsLocation

Optional companionAxisLabelOpposite

Gets or sets whether or not the companion axis has opposite location of this axis.

companionAxisLabelOpposite?: string | boolean

Optional companionAxisLabelVerticalAlignment

Gets or sets vertical alignment of the companion axis.

companionAxisLabelVerticalAlignment?: any

Optional companionAxisLabelVisible

Gets or sets whether or not the companion axis has visible labels.

companionAxisLabelVisible?: any

Optional companionAxisMajorStroke

Gets or sets stroke of major gridlines on the companion axis.

companionAxisMajorStroke?: string

Optional companionAxisMajorStrokeThickness

Gets or sets thickness of major gridlines on the companion axis.

companionAxisMajorStrokeThickness?: string | number

Optional companionAxisMinExtent

Gets or sets label angle on the companion axis.

companionAxisMinExtent?: string | number

Optional companionAxisMinorStroke

Gets or sets stroke of minior gridlines on the companion axis.

companionAxisMinorStroke?: string

Optional companionAxisMinorStrokeThickness

Gets or sets thickness of minior gridlines on the companion axis.

companionAxisMinorStrokeThickness?: string | number

Optional companionAxisShouldAutoTruncateAnnotations

Gets or sets whether or not the companion axis should auto truncate annotations.

companionAxisShouldAutoTruncateAnnotations?: any

Optional companionAxisShouldAvoidAnnotationCollisions

Gets or sets whether or not the companion axis should avoid annotation collisions.

companionAxisShouldAvoidAnnotationCollisions?: any

Optional companionAxisShouldKeepAnnotationsInView

Gets or sets whether or not the companion axis should keep annotations in view.

companionAxisShouldKeepAnnotationsInView?: any

Optional companionAxisStrip

Gets or sets color of strips on the companion axis.

companionAxisStrip?: string

Optional companionAxisStroke

Gets or sets color of line stroke on the companion axis.

companionAxisStroke?: string

Optional companionAxisStrokeThickness

Gets or sets label angle on the companion axis.

companionAxisStrokeThickness?: string | number

Optional companionAxisSyncronizedWithPrimaryAxis

Gets or sets whether or not the companion axis is syncronized with properties of primary axis unless CompanionAxis* properties are set In other words, companion axis' LabelExtent will syncronize with primary axis' LabelExtent unless CompanionAxisLabelExtent is set

companionAxisSyncronizedWithPrimaryAxis?: string | boolean

Optional companionAxisTickLength

Gets or sets length of ticks on the companion axis.

companionAxisTickLength?: string | number

Optional companionAxisTickStroke

Gets or sets color of ticks on the companion axis.

companionAxisTickStroke?: string

Optional companionAxisTickStrokeThickness

Gets or sets label angle on the companion axis.

companionAxisTickStrokeThickness?: string | number

Optional companionAxisTitle

Gets or sets title on the companion axis.

companionAxisTitle?: string

Optional crossingAxis

Gets or sets the CrossingAxis property.

The CrossingAxis property is used for CrossingAxis .

crossingAxis?: IgrAxis

Optional crossingAxisName

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

crossingAxisName?: string

Optional crossingValue

Gets or sets the CrossingValue property.

The CrossingValue property is used for CrossingValue of the axis.

crossingValue?: any

Optional enhancedIntervalMinimumCharacters

Gets or sets the minimum 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.

enhancedIntervalMinimumCharacters?: string | number

Optional enhancedIntervalPreferMoreCategoryLabels

Gets or sets whether the enhanced interval management should prefer to show all the labels if possible without collisions for supported types of category axes. This is for use with EnhancedIntervalMinimumCharacters = -1 and axes that have an integral interval.

enhancedIntervalPreferMoreCategoryLabels?: string | boolean

Optional expectFunctions

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.

expectFunctions?: string | boolean

Optional formatLabel

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.

formatLabel?: object

Optional isCompanionAxis

Gets whether this is companion axis automatically created for a primary axis

isCompanionAxis?: string | boolean

Optional isDisabled

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.

isDisabled?: string | boolean

Optional isInverted

Gets or sets the IsInverted property.

Gets or sets the IsInverted property.

isInverted?: string | boolean

Optional label

Gets or sets the axis label format string.

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

label?: any

Optional labelAngle

Gets or sets the angle of the {0}.

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

labelAngle?: string | number

Optional labelBottomMargin

Margin applied below the {0}.

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

labelBottomMargin?: string | number

Optional labelExtent

Distance between the axis and the edge of the control.

The Extent property is used for the extent.

labelExtent?: string | number

Optional labelFormat

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

labelFormat?: string

Optional labelFormatSpecifiers

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

labelFormatSpecifiers?: any[]

Optional labelHorizontalAlignment

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

The HorizontalAlignment property is used for the horizontal alignment.

labelHorizontalAlignment?: any

Optional labelLeftMargin

Margin applied to the left of the {0}.

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

labelLeftMargin?: string | number

Optional labelLocation

Gets or sets the location of the {0}.

The Location property is used for the location.

labelLocation?: string | AxisLabelsLocation

Optional labelMaximumExtent

Maximum distance between the axis and the edge of the control.

labelMaximumExtent?: string | number

Optional labelMaximumExtentPercentage

Maximum distance between the axis and the edge of the control, relative to Chart size.

labelMaximumExtentPercentage?: string | number

Optional labelRightMargin

Margin applied to the right of the {0}.

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

labelRightMargin?: string | number

Optional labelShowFirstLabel

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.

labelShowFirstLabel?: string | boolean

Optional labelTextColor

The color of the {0}.

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

labelTextColor?: string

Optional labelTextStyle

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.

labelTextStyle?: string

Optional labelTopMargin

Margin applied above the {0}.

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

labelTopMargin?: string | number

Optional labelVerticalAlignment

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

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

labelVerticalAlignment?: any

Optional labelVisibility

Gets or sets the visibility of the {0}.

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

labelVisibility?: any

Optional majorStroke

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.

majorStroke?: string

Optional majorStrokeDashArray

Gets or sets the MajorStrokeDashArray property.

majorStrokeDashArray?: string | number[]

Optional majorStrokeThickness

Gets or sets the MajorStrokeThickness property.

Gets or sets the MajorStrokeThickness using this property.

majorStrokeThickness?: string | number

Optional minorStroke

Gets or sets the MinorStroke property.

Gets or sets the minorStroke thickness using MinorStrokeThickness property.

minorStroke?: string

Optional minorStrokeDashArray

Gets or sets the MinorStrokeDashArray property.

minorStrokeDashArray?: string | number[]

Optional minorStrokeThickness

Gets or sets the MinorStrokeThickness property.

minorStrokeThickness?: string | number

name

Sets or gets a required unique name for the axis.

name: string

Optional rangeChanged

Occurs when the axis range changes.

rangeChanged?: object

Optional renderRequested

This event is raised every time a render has been requested from a series.

renderRequested?: object

Optional shouldAutoTruncateAnnotations

Gets or sets whether annotations on this axis will automatically truncate themselves to avoid colliding with each other. This only works if the ShouldAvoidAnnotationCollisions property is enabled.

shouldAutoTruncateAnnotations?: string | boolean

Optional shouldAvoidAnnotationCollisions

Gets or sets whether annotations should be shifted to avoid collision, even if this would result in them appearing where they shouldn't be along the scale.

shouldAvoidAnnotationCollisions?: string | boolean

Optional shouldKeepAnnotationsInView

ets or sets whether annotations should be kept in view, even if they aren't positioned where they should appear on the scale.

shouldKeepAnnotationsInView?: string | boolean

Optional strip

Gets or sets the Strip property.

Use Strip property to set the strip of the chart.

strip?: string

Optional stroke

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.

stroke?: string

Optional strokeDashArray

Gets or sets the StrokeDashArray property.

strokeDashArray?: string | number[]

Optional strokeThickness

Gets or sets the StrokeThickness property.

Use StrokeThickness property for the thickness of the stroke.

strokeThickness?: string | number

Optional tickLength

Gets or sets the TickLength property.

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

tickLength?: string | number

Optional tickStroke

Gets or sets the TickStroke property.

Use TickStroke property for the color of the tickmarks.

tickStroke?: string

Optional tickStrokeDashArray

Gets or sets the TickStrokeDashArray property.

tickStrokeDashArray?: string | number[]

Optional tickStrokeThickness

Gets or sets the TickStrokeThickness property.

Use TickStrokeThickness property for thickness of the stroke tickmarks.

tickStrokeThickness?: string | number

Optional title

Gets or sets the Title property.

Use Title property to display the title of the component.

title?: string

Optional titleAngle

Gets or sets the angle of the {0}.

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

titleAngle?: string | number

Optional titleBottomMargin

Margin applied below the {0}.

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

titleBottomMargin?: string | number

Optional titleExtent

Distance between the axis and the edge of the control.

The Extent property is used for the extent.

titleExtent?: string | number

Optional titleHorizontalAlignment

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

The HorizontalAlignment property is used for the horizontal alignment.

titleHorizontalAlignment?: any

Optional titleLeftMargin

Margin applied to the left of the {0}.

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

titleLeftMargin?: string | number

Optional titleLocation

Gets or sets the location of the {0}.

The Location property is used for the location.

titleLocation?: string | AxisLabelsLocation

Optional titleMaximumExtent

Maximum distance between the axis and the edge of the control.

titleMaximumExtent?: string | number

Optional titleMaximumExtentPercentage

Maximum distance between the axis and the edge of the control, relative to Chart size.

titleMaximumExtentPercentage?: string | number

Optional titlePosition

Gets or sets the title position relative to the axis labels.

titlePosition?: string | AxisTitlePosition

Optional titleRightMargin

Margin applied to the right of the {0}.

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

titleRightMargin?: string | number

Optional titleShowFirstLabel

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.

titleShowFirstLabel?: string | boolean

Optional titleTextColor

The color of the {0}.

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

titleTextColor?: string

Optional titleTextStyle

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.

titleTextStyle?: string

Optional titleTopMargin

Margin applied above the {0}.

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

titleTopMargin?: string | number

Optional titleVerticalAlignment

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

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

titleVerticalAlignment?: any

Optional titleVisibility

Gets or sets the visibility of the {0}.

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

titleVisibility?: any

Optional useEnhancedIntervalManagement

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.

useEnhancedIntervalManagement?: string | boolean

Optional usePerLabelHeightMeasurement

Gets or sets whether to use label height measurement when determining the initial number of labels to render, before resolving collisions, etc.

usePerLabelHeightMeasurement?: string | boolean