Action
    Preparing search index...

    Class BoxPlot

    Represents a box plot.

    Box plots are used to visualize key statistical measures, such as median, mean and quartiles. The measures are shown on the Y-axis for each category defined by the X-axis.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    BoxWidth ColorAxis ComparisonCircles Context Data DefaultFontMetadata Description Details FittingModels HorizontalLegend IsAttached Layers Legend MarkerSize Orientation ReferencePoints Show95PercentConfidenceInterval ShowDescription ShowDistribution SupportsTransparency Table Title Transactions Transparency Trellis TypeId UseRelativeScale UseSeparateColorForMarkedItems Violin Visual XAxis XJitter 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.

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • 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 BoxWidth(): number

      Gets or sets the width of the boxes. Allowed values are in the range [0, 100].

      Returns number

      The marker size is expressed relative to the width of a category on the x-axis. A value of 100 means it will occupy the full width.

      2.0

    • set BoxWidth(value: number): void

      Parameters

      • value: number

      Returns void

    • get Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get DefaultFontMetadata(): FontMetadata

      Gets or sets the default font for the plot.

      Returns FontMetadata

      2.0

    • set DefaultFontMetadata(value: FontMetadata): void

      Parameters

      Returns void

    • 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 IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get MarkerSize(): number

      Gets or sets the size of the markers.

      Returns number

      The marker size is expressed relative to the width of a category on the x-axis. A value of 100 means it will occupy the full width.

      2.0

    • set MarkerSize(value: number): void

      Parameters

      • value: number

      Returns void

    • get Show95PercentConfidenceInterval(): boolean

      Gets or sets a value indicating whether 95 % confidence intervals are drawn.

      Returns boolean

      2.0

    • set Show95PercentConfidenceInterval(value: boolean): void

      Parameters

      • value: boolean

      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 ShowDistribution(): boolean

      Gets or sets a value indicating whether distributions are drawn within the boxes.

      Returns boolean

      2.0

    • set ShowDistribution(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • 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 Trellis(): Trellis

      Gets the trellis.

      Returns Trellis

      2.0

    • get TypeId(): TypeIdentifier

      Gets the type identifier for the visual.

      Returns TypeIdentifier

      2.0

    • get UseRelativeScale(): boolean

      Gets or sets a value indicating whether to use relative scale on the Y-axis.

      Returns boolean

      2.0

    • set UseRelativeScale(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • 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 Violin(): BoxPlotViolin

      Gets the object used to control the the display of the distribution in the shape of a violin.

      Returns BoxPlotViolin

      2.2

    • get Visual(): null | Visual

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

      Returns null | Visual

      2.0

    • get XJitter(): number

      Gets or sets the amount of jittering in the x direction.

      Returns number

      Jittering is applied to outer values only. It does not affect the boxes.

      2.0

    • set XJitter(value: number): void

      Parameters

      • value: number

      Returns void

    • 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