Class ErrorBars

Represents Error Bars on a Spotfire.Dxp.Application.Visuals.ScaleAxis.

Remark

Error bars are lines drawn from the center of a marker (or from the end of a bar in a bar chart) to indicate the error (uncertainty) of a measurement or aggregation.

Since

2.0

Hierarchy (View Summary)

DocumentNode
- ErrorBars

Implements

Methods

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from DocumentNode.Cast

Equals

Equals(obj: any): boolean
Determines whether the specified object is equal to the current object.
Parameters
- obj: any
  The object to compare with the current object.
Returns boolean
true if the specified object is equal to the current object; otherwise, false.

Inherited from DocumentNode.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from DocumentNode.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from DocumentNode.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): null | T1
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from DocumentNode.TryCast

`Static`Equals

Equals(objA: any, objB: any): boolean
Determines whether the specified object instances are considered equal.
Parameters
- objA: any
  The first object to compare.
- objB: any
  The second object to compare.
Returns boolean
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Inherited from DocumentNode.Equals

Default capability

Context

get Context(): INodeContext
Gets the context of this node.

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

Enabled

get Enabled(): boolean
Gets or sets whether or not the error bars are enabled.

Returns boolean
Since
2.0
set Enabled(value: boolean): void
Parameters
- value: boolean
Returns void

FixedColor

get FixedColor(): Color
Gets or sets the fixed color used for drawing error bars when Spotfire.Dxp.Application.Visuals.ErrorBars.UseMarkerColor is false.

Returns Color
Remark
This color is only used when Spotfire.Dxp.Application.Visuals.ErrorBars.UseMarkerColor is false.

Since
2.0
set FixedColor(value: Color): void
Parameters
- value: Color
Returns void

IncludeInAxisRange

get IncludeInAxisRange(): boolean
Gets or sets whether or not the error bars should be included in the axis range of the visualization.

Returns boolean
Since
2.0
set IncludeInAxisRange(value: boolean): void
Parameters
- value: boolean
Returns void

IndexedEnabled

get IndexedEnabled(): IndexedBool
Gets the indexed enabled property.

Returns IndexedBool
Remark
The indexed enabled property is used instead of the Spotfire.Dxp.Application.Visuals.ErrorBars.Enabled property when there are multiple measures on the Spotfire.Dxp.Application.Visuals.ScaleAxis (e.g. multiple columns on the Y axis in a line chart).

Since
2.0

IndexedLowerExpression

get IndexedLowerExpression(): IndexedExpression
Gets the indexed Lower Expression property.

Returns IndexedExpression
Remark
The indexed lower expression property is used instead of the Spotfire.Dxp.Application.Visuals.ErrorBars.LowerExpression property when there are multiple measures on the Spotfire.Dxp.Application.Visuals.ScaleAxis (e.g. multiple columns on the Y axis in a line chart). Pre-processor syntax is not supported. Expressions with pre-processor syntax will be stored as static values, that is, what it evaluates to when set.

Since
2.0

IndexedUpperExpression

get IndexedUpperExpression(): IndexedExpression
Gets the indexed Upper Expression property.

Returns IndexedExpression
Remark
The indexed upper expression property is used instead of the Spotfire.Dxp.Application.Visuals.ErrorBars.UpperExpression property when there are multiple measures on the Spotfire.Dxp.Application.Visuals.ScaleAxis (e.g. multiple columns on the Y axis in a line chart). Pre-processor syntax is not supported. Expressions with pre-processor syntax will be stored as static values, that is, what it evaluates to when set.

Since
2.0

IsAttached

get IsAttached(): boolean
Gets a value indicating whether this node is attached.

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.IsAttached

LegendItemReference

get LegendItemReference(): LegendErrorBarsItem
Gets a reference to the corresponding legend item.

Returns LegendErrorBarsItem
Since
2.0

LowerExpression

get LowerExpression(): string
Gets or sets the expression used to define the lower error of the error bar.

Returns string
Remark
The expression must evaluate to a numeric value. Pre-processor syntax is not supported. Expressions with pre-processor syntax will be stored as static values, that is, what it evaluates to when set.

Since
2.0
set LowerExpression(value: string): void
Parameters
- value: string
Returns void

ShowEndCaps

get ShowEndCaps(): boolean
Gets or sets whether or not the error bars should be drawn using end caps.

Returns boolean
Remark
End caps are small perpendicular lines at the end of error bars.

Since
2.0
set ShowEndCaps(value: boolean): void
Parameters
- value: boolean
Returns void

Transactions

get Transactions(): ITransactions
Gets a collection of methods for executing transactions on the document.

Returns ITransactions
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Transactions

UpperExpression

get UpperExpression(): string
Gets or sets the expression used to define the upper error of the error bar.

Returns string
Remark
The expression must evaluate to a numeric value. Pre-processor syntax is not supported. Expressions with pre-processor syntax will be stored as static values, that is, what it evaluates to when set.

Since
2.0
set UpperExpression(value: string): void
Parameters
- value: string
Returns void

UseMarkerColor

get UseMarkerColor(): boolean
Gets or sets whether to use marker colors when drawing error bars.

Returns boolean
Since
2.0
set UseMarkerColor(value: boolean): void
Parameters
- value: boolean
Returns void

ForEachNodeInSubTree

ForEachNodeInSubTree<TNode>(
typeTNode: TypeRefParam<TNode>,
action: Action<TNode>,
): void
Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node.
Type Parameters
- TNode
Parameters
- typeTNode: TypeRefParam<TNode>
  Generic type argument
- action: Action<TNode>
  The action to apply.
Returns void
Since
2.1

Inherited from DocumentNode.ForEachNodeInSubTree

Class ErrorBars

Remark

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Methods

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

StaticEquals

Parameters

Returns boolean

Default capability

Context

Returns INodeContext

Since

Enabled

Returns boolean

Since

Parameters

Returns void

FixedColor

Returns Color

Remark

Since

Parameters

Returns void

IncludeInAxisRange

Returns boolean

Since

Parameters

Returns void

IndexedEnabled

Returns IndexedBool

Remark

Since

IndexedLowerExpression

Returns IndexedExpression

Remark

Since

IndexedUpperExpression

Returns IndexedExpression

Remark

Since

IsAttached

Returns boolean

Since

LegendItemReference

Returns LegendErrorBarsItem

Since

LowerExpression

Returns string

Remark

Since

Parameters

Returns void

ShowEndCaps

Returns boolean

Remark

Since

Parameters

Returns void

Transactions

Returns ITransactions

Since

`Static`Equals