Action
    Preparing search index...

    Class SparklineMiniatureVisualization

    A miniature visualization that can render sparklines.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    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 ForEachNodeInSubTree IsConfigurationValid RefreshOnDemandData TryGetFilterRules

    Methods

    • 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

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

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • 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

    • 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

    • get Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get Description(): string

      Gets or sets the plot description.

      Returns string

      2.0

    • set Description(value: string): void

      Parameters

      • value: string

      Returns void

    • get HorizontalLegend(): HorizontalLegend

      Gets the horizontal legend object for this plot.

      Returns HorizontalLegend

      2.0

    • 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

      When filtering is inherited, the filtering settings under the Data property of this node is not used.

      2.0

    • set InheritFiltering(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get LineColor(): Color

      Gets or sets the color of the sparkline line.

      Returns Color

      2.0

    • set LineColor(value: Color): void

      Parameters

      Returns void

    • get LineWidth(): number

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

      Returns number

      2.0

    • set LineWidth(value: number): void

      Parameters

      • value: number

      Returns void

    • get ShowDescription(): boolean

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

      Returns boolean

      2.0

    • set ShowDescription(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get ShowStartValue(): boolean

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

      Returns boolean

      2.0

    • set ShowStartValue(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get ShowStopValue(): boolean

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

      Returns boolean

      2.0

    • set ShowStopValue(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get SupportsSorting(): boolean

      Gets a value indicating whether this miniature visualization supports sorting.

      Returns boolean

      2.0

    • get SupportsTransparency(): boolean

      Gets a value indicating whether transparency is supported.

      Returns boolean

      2.0

    • get Transactions(): ITransactions

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

      Returns ITransactions

      2.0

    • get Transparency(): number

      Gets or sets the transparency for the plot.

      Returns number

      2.0

    • set Transparency(value: number): void

      Parameters

      • value: number

      Returns void

    • get TypeId(): TypeIdentifier

      Gets the type identifier for the visual.

      Returns TypeIdentifier

      2.0

    • get UseSeparateColorForMarkedItems(): boolean

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

      Returns boolean

      2.0

    • set UseSeparateColorForMarkedItems(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get ValueColumnWidth(): number

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

      Returns number

      2.0

    • set ValueColumnWidth(value: number): void

      Parameters

      • value: number

      Returns void

    • get Visual(): null | Visual

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

      Returns null | Visual

      2.0

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

      Returns void

      This method is called when a visual is created by the user, but the exact configuration produced is undefined and can change between versions. This method should only be used if you want to mimic the user's action in the application, and it should only be called once. It implicity calls Spotfire.Dxp.Application.Visuals.VisualContent.ApplyUserPreferences.
      Code samples on how to create and configure a visualization are available in Spotfire Technology Network. Additional action needed for the Map Chart: in order to load the default layers (i.e. base map layer) you need to explicitly call Spotfire.Dxp.Application.Visuals.Maps.MapChart.AutoConfigureLayers.

      2.0

    • Determines whether the current plot configuration is valid.

      Returns boolean

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

      2.0

    • 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

      This will only refresh the data tables where the Spotfire.Dxp.Data.DataTable.NeedsRefresh property is true.

      2.0

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability