Stroke Class

Spotfire 14.7 API Reference

Represents the settings for a line, including its line style and color.

Inheritance Hierarchy

SystemObject
Spotfire.Dxp.Application.Visuals.StylesStroke

Namespace: Spotfire.Dxp.Application.Visuals.Styles
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 69.0.21424.2902 (69.0.21424.2902)

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(68, 0)]
[ImmutableAttribute]
public sealed class Stroke : ISerializable, 
	IEquatable<Stroke>

The Stroke type exposes the following members.

Constructors

	Name	Description
	Stroke	Initializes a new instance of the Stroke class with default values, i.e. a one pixel wide black line.

Top

Properties

	Name	Description
	Color	Gets the color of the line.
	ColorLightnessFactor	Gets the factor used to blend the color towards black or white. This is only used when ColorType is Default This is linear interpolation where 0 means no blending, and -1 means all black or 1 is all white.
	ColorType	Gets the color type for the line.
	Style	Gets the line style of the line.
	Width	Gets the width of the line in pixels.

Top

Methods

	Name	Description
	Equals(Object)	Determines whether the specified object is equal to the current object. (Overrides ObjectEquals(Object).)
	Equals(Stroke)	Determines whether the specified Stroke is equal to the current Stroke.
	GetHashCode	Serves as the default hash function. (Overrides ObjectGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	WithColor	Creates a new Stroke with the given color.
	WithDefaultColor	Creates a new Stroke with default color. The color is inherited from the coloring in the visualization or theme.
	WithDefaultColor(Single)	Creates a new Stroke with default color. The color is inherited from the coloring in the visualization or theme.
	WithStyle	Creates a new Stroke with the given line style.
	WithWidth	Creates a new Stroke with the given width.

Top

Explicit Interface Implementations

	Name	Description
	ISerializableGetObjectData	Populates a SerializationInfo with the data needed to serialize the target object.

Top

Remarks

This type provides functionality to manage the style and color settings of a line.

Version Information

Supported in: 14.7, 14.6

Reference

Spotfire.Dxp.Application.Visuals.Styles Namespace