About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class ErrorBars

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

Since

2.0

Hierarchy (view full)

DocumentNode
- ErrorBars

Implements

Methods

Cast

Cast<T1, T2>(this, type): 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): 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, type): 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, objB): 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): 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
Since
2.0
set FixedColor(value): 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): void
Parameters
- value: boolean
Returns void

IndexedEnabled

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

Returns IndexedBool
Since
2.0

IndexedLowerExpression

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

Returns IndexedExpression
Since
2.0

IndexedUpperExpression

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

Returns IndexedExpression
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
Since
2.0
set LowerExpression(value): 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
Since
2.0
set ShowEndCaps(value): 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
Since
2.0
set UpperExpression(value): 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): void
Parameters
- value: boolean
Returns void