Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Visualization

Index

Type aliases

IconType

IconType: "AUTO" | "CUSTOM" | "NONE"

Indicates whether an icon should be auto-generated ('AUTO'), no thumbnail should be saved ('NONE'), or the existing custom thumbnail should be kept ('CUSTOM').

Variables

Const Aggregate

Aggregate: {} = {/** Calculates an average. */AVG: 'AVG',/** Returns the total number of data points. */COUNT: 'COUNT',/** Returns the maximum value. */MAX: 'MAX',/** Returns the minimum value. */MIN: 'MIN',/** Calculates a sum/total. */SUM: 'SUM'}
namespace

Aggregate aggregates when pivoting a resultset by a dimension. See getData.

Type declaration

Const Interval

Interval: {} = {/** Align by the number of days since the zero date. */DAY : 'DAY',/** Align by the number of months since the zero date. */MONTH : 'MONTH',/** Align by the number of weeks since the zero date. */WEEK : 'WEEK',/** Align by the number of years since the zero date. */YEAR: 'YEAR'}
namespace

Interval intervals are for aligning series in time plots. See getData.

Type declaration

Const Type

Type: {} = {/*** Plot types that are not study specific (i.e. Bar, Box, Pie, and Scatter).*/GenericChart: 'ReportService.GenericChartReport',/*** Plots data over time, aligning different series based on configurable start dates.*/TimeChart: 'ReportService.TimeChartReport'}
namespace

Type predefined set of visualization types, for use in the config.type property in the save method.

Type declaration

Functions

get

getData

getDataFilterFromURL

  • getDataFilterFromURL(): string

getFromUrl

  • Retrieves a saved visualization based on identifying parameters found on the current URL. Method returns true or false, depending on whether the URL contains a saved visualization identifier. If true, the success or failure callback function will be called just as with get. If false, no callbacks will be called. This method allows callers to use a single method to retrieve saved visualizations, regardless of how they are identified on the URL.

    Parameters

    Returns boolean

    Indicates whether the current URL includes parameters that identify a saved visualization.

getMeasures

getTypes

save

  • Saves a visualization for future use. Saved visualizations appear in the study 'views' webpart. If the visualization is scoped to a specific query, it will also appear in the views menu for that query.

    Parameters

    Returns XMLHttpRequest

Generated using TypeDoc