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

Class BorderRadius

Represents border radius for a corner in a box.

Since

2.0

Hierarchy (view full)

Spotfire.Object
- BorderRadius

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

constructor Zero X Y

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

Equals

Equals(obj): boolean
Indicates whether this instance and a specified object are equal.
Parameters
- obj: any
  The object to compare with the current instance.
Returns boolean
true if obj and this instance are the same type and represent the same value; otherwise, false.

Overrides Object.Equals

GetHashCode

GetHashCode(): number
Returns the hash code for this instance.

Returns number
A 32-bit signed integer that is the hash code for this instance.

Overrides Object.GetHashCode

ToString

ToString(): string
Returns the fully qualified type name of this instance.

Returns string
The fully qualified type name.

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

Default capability

constructor

new BorderRadius(radius): BorderRadius
Initializes a new instance of the Spotfire.Dxp.Framework.Styles.BorderRadius struct. X and Y radius are the same.
Parameters
- radius: number | Int32
  The radius.
Returns BorderRadius
Since
2.0

Overrides Object.constructor
new BorderRadius(x, y): BorderRadius
Initializes a new instance of the Spotfire.Dxp.Framework.Styles.BorderRadius struct.
Parameters
- x: number | Int32
  The x radius.
- y: number | Int32
  The y raidus.
Returns BorderRadius
Since
2.0

Overrides Object.constructor

`Static` `Readonly`Zero

Zero: BorderRadius

The zero border radius, that is, a corner that is not rounded at all.

Since

2.0

X

get X(): number
Gets the X radius.

Returns number
Since
2.0

Y

get Y(): number
Gets the Y radius.

Returns number
Since
2.0