Class SparklineMiniatureVisualization

A miniature visualization that can render sparklines.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context Data Description Details HorizontalLegend InheritFiltering IsAttached Legend LineColor LineWidth ShowDescription ShowStartValue ShowStopValue SupportsSorting SupportsTransparency Title Transactions Transparency TypeId UseSeparateColorForMarkedItems ValueColumnWidth Visual XAxis YAxis ApplyUserPreferences AutoConfigure IsConfigurationValid RefreshOnDemandData TryGetFilterRules

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

    Returns T1

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.

GetHashCode

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

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

    Returns null | T1

StaticEquals

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

Default capability

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

Data

Description

  • get Description(): string

  • Gets or sets the plot description.

    Returns string

    Since

    2.0

  • set Description(value): void

  • Parameters

    • value: string

    Returns void

Details

HorizontalLegend

  • get HorizontalLegend(): HorizontalLegend

  • Gets the horizontal legend object for this plot.

    Returns HorizontalLegend

    Since

    2.0

InheritFiltering

  • get InheritFiltering(): boolean

  • Gets or sets a value indicating whether filtering behavior is inherited from the owner of this visualization. It is only used in the case where the owner has filtering settings, i.e. when the owner os a graphical table.

    Returns boolean

    Since

    2.0

  • set InheritFiltering(value): void

  • Parameters

    • value: boolean

    Returns void

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

Legend

  • get Legend(): Legend

  • Gets the legend object for this plot.

    Returns Legend

    Since

    2.0

LineColor

  • get LineColor(): Color

  • Gets or sets the color of the sparkline line.

    Returns Color

    Since

    2.0

  • set LineColor(value): void

  • Parameters

    Returns void

LineWidth

  • get LineWidth(): number

  • Gets or sets the width of the sparkline line, in pixels.

    Returns number

    Since

    2.0

  • set LineWidth(value): void

  • Parameters

    • value: number

    Returns void

ShowDescription

  • get ShowDescription(): boolean

  • Gets or sets a flag indicating whether to show the description or not.

    Returns boolean

    Since

    2.0

  • set ShowDescription(value): void

  • Parameters

    • value: boolean

    Returns void

ShowStartValue

  • get ShowStartValue(): boolean

  • Gets or sets a value indicating whether the start value of the sparkline shall be shown.

    Returns boolean

    Since

    2.0

  • set ShowStartValue(value): void

  • Parameters

    • value: boolean

    Returns void

ShowStopValue

  • get ShowStopValue(): boolean

  • Gets or sets a value indicating whether the last value of the sparkline shall be shown.

    Returns boolean

    Since

    2.0

  • set ShowStopValue(value): void

  • Parameters

    • value: boolean

    Returns void

SupportsSorting

  • get SupportsSorting(): boolean

  • Gets a value indicating whether this miniature visualization supports sorting.

    Returns boolean

    Since

    2.0

SupportsTransparency

  • get SupportsTransparency(): boolean

  • Gets a value indicating whether transparency is supported.

    Returns boolean

    Since

    2.0

Title

  • get Title(): string

  • Gets or sets the Visual's title.

    Returns string

    Since

    2.0

  • set Title(value): void

  • Parameters

    • value: string

    Returns void

Transactions

  • get Transactions(): ITransactions

  • Gets a collection of methods for executing transactions on the document.

    Returns ITransactions

    Since

    2.0

Transparency

  • get Transparency(): number

  • Gets or sets the transparency for the plot.

    Returns number

    Since

    2.0

  • set Transparency(value): void

  • Parameters

    • value: number

    Returns void

TypeId

  • get TypeId(): TypeIdentifier

  • Gets the type identifier for the visual.

    Returns TypeIdentifier

    Since

    2.0

UseSeparateColorForMarkedItems

  • get UseSeparateColorForMarkedItems(): boolean

  • Gets or sets a value indicating whether to use a separate color for marked items.

    Returns boolean

    Since

    2.0

  • set UseSeparateColorForMarkedItems(value): void

  • Parameters

    • value: boolean

    Returns void

ValueColumnWidth

  • get ValueColumnWidth(): number

  • Gets or sets the width of a value column in pixels.

    Returns number

    Since

    2.0

  • set ValueColumnWidth(value): void

  • Parameters

    • value: number

    Returns void

Visual

  • get Visual(): null | Visual

  • Gets the visual instance, or null if this instance is not owned by a visual.

    Returns null | Visual

    Since

    2.0

XAxis

YAxis

ApplyUserPreferences

AutoConfigure

  • AutoConfigure(): void

  • Configures a newly created visual with reasonable default values given the current data set.

    Returns void

    Since

    2.0

IsConfigurationValid

  • IsConfigurationValid(): boolean

  • Determines whether the current plot configuration is valid.

    Returns boolean

    true if the current plot configuration is valid; otherwise, false.

    Since

    2.0

RefreshOnDemandData

  • RefreshOnDemandData(): void

  • Refreshes data in data tables that depends on other data and is not automatically updated. This includes on-demand data with manual refresh, data functions with update behavior Manual and calculations with update behavior Invalidate. Only data tables used by this visualization will be included.

    Returns void

    Since

    2.0

TryGetFilterRules

  • TryGetFilterRules(filterRules): boolean

  • Try to get the filter rules for the plot.

    Parameters

    Returns boolean

    false if this visualization does not support filter, rules, otherwise true.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability