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

Class ValueRendererArgs

Renderer settings used by a Spotfire.Dxp.Application.Visuals.ValueRenderers.ValueRenderer when rendering a data value.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- ValueRendererArgs

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

DataValue DataValueProperties FormattedValue Height PixelRatio Size Width

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 Object.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.

Overrides Object.Equals
Equals(other: ValueRendererArgs): boolean
Indicates whether the current object is equal to another object of the same type.
Parameters
- other: ValueRendererArgs
  An object to compare with this object.
Returns boolean
true if the current object is equal to the other parameter; otherwise, false.

Overrides Object.Equals

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

ToString

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

Returns string
A string that represents the current object.

Inherited from Object.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 Object.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 Object.Equals

Default capability

DataValue

get DataValue(): DataValue
Gets the data value.

Returns DataValue
Since
2.0

DataValueProperties

get DataValueProperties(): DataValueProperties
Gets the properties of the data value.

Returns DataValueProperties
Since
2.0

FormattedValue

get FormattedValue(): string
Gets the formatted data value.

Returns string
Since
2.0

Height

get Height(): number
Gets the height in pixels.

Returns number
Since
2.0

PixelRatio

get PixelRatio(): number
Gets the size factor between logical and physical pixels. The Width, Height and Size properties of this class are all in logical pixels. If the result is a bitmap, the Width and Height propertes should be multiplied by PixelRatio to provide an image with suitable resolution.

Returns number
Since
2.0

Size

get Size(): Size
Gets the size in pixels.

Returns Size
Since
2.0

Width

get Width(): number
Gets the width in pixels.

Returns number
Since
2.0