dundas.view.controls.ReportEditor Class

The adapter to represent a report in edit mode.

Inheritance Hierarchy

Class
   dundas.Component
      dundas.view.controls.BasicAdapter
         dundas.view.controls.CanvasAdapter
            dundas.view.controls.RepeaterAdapter
               dundas.view.controls.Report
                  dundas.view.controls.ReportEditor

Constructors

	Name	Description
	init	Initializes the Adapter. Called during construction. Inherited from dundas.view.controls.BasicAdapter.

Properties

	Name	Description
	background	Gets or sets the background for the dashboard. Inherited from dundas.view.controls.CanvasAdapter.
	baseViewService	Gets the base view service. This might be a dundas.views.BaseViewViewService or derivation thereof if this adapter is on a View entity. A way to check is to duck-type for .currentView. Inherited from dundas.view.controls.BasicAdapter.
	chatflowId	Gets or sets the chatflow to use for this view. Inherited from dundas.view.controls.CanvasAdapter.
	container	Gets or sets the container DIV element which holds the DOM control element. Inherited from dundas.view.controls.BasicAdapter.
	control	Gets or sets the repeater view entity that this adapter is "wrapping." Inherited from dundas.view.controls.CanvasAdapter.
	designer	Gets the designer model of this adapter. Inherited from dundas.view.controls.RepeaterAdapter.
	entityViewService	Gets the base service class for reports. Inherited from dundas.view.controls.Report.
	fontColor	Gets or sets the font color for the adapter. Inherited from dundas.view.controls.CanvasAdapter.
	fontFamily	Gets or sets the font family for this adapter. Inherited from dundas.view.controls.CanvasAdapter.
	fontSize	Gets or sets the font size for this adapter. Inherited from dundas.view.controls.CanvasAdapter.
	fontStyle	Gets or sets the font style for this adapter. Inherited from dundas.view.controls.CanvasAdapter.
	fontVariant	Gets or sets the font variant for this adapter. Inherited from dundas.view.controls.CanvasAdapter.
	fontWeight	Gets or sets the font weight for this adapter. Inherited from dundas.view.controls.CanvasAdapter.
	friendlyName	Gets or sets the friendly name for this adapter which is the name shown to the end user. Inherited from dundas.view.controls.BasicAdapter.
	height	Gets or sets the height value. Inherited from dundas.view.controls.BasicAdapter.
	id	Gets or sets the ID for this adapter (constant, unique). Inherited from dundas.view.controls.BasicAdapter.
	ignoreAspectRatioOnResize	Gets or sets a value indicating whether or not the aspect ratio is ignored when using re-size mode in view mode. Inherited from dundas.view.controls.CanvasAdapter.
	isAdhoc	Gets whether or not this adapter represents an ad hoc dashboard. Inherited from dundas.view.controls.CanvasAdapter.
	isCanvasAdapter	Gets a value indicating that this adapter is a 'canvas' adapter. Inherited from dundas.view.controls.CanvasAdapter.
	isDisposed	Gets a value indicating whether this instance has been disposed. Inherited from dundas.Component.
	isInTemplate	Gets or sets if this adapter is part of a canvas template. Inherited from dundas.view.controls.BasicAdapter.
	isParameterSelectionRequiredBeforeLoad	Gets or sets a value to indicate whether or not the cell is hidden. Inherited from dundas.view.controls.RepeaterAdapter.
	isSimplePropertyPanelOpen	Gets a value indicating whether the simple property panel is open or not. Inherited from dundas.view.controls.BasicAdapter.
	isSubCanvas	Gets or sets a value indicating that this canvas adapter is in a subcanvas. Inherited from dundas.view.controls.CanvasAdapter.
	isTemplate	Gets whether or not this adapter represents a template. Inherited from dundas.view.controls.CanvasAdapter.
	layerAdapters	Gets or sets the layer adapters of this canvas Inherited from dundas.view.controls.CanvasAdapter.
	layerId	Gets or sets the ID of the layer that this adapter belongs to. Inherited from dundas.view.controls.BasicAdapter.
	left	Gets or sets the left value. Inherited from dundas.view.controls.BasicAdapter.
	locked	Gets or sets a value indicating whether this adapter is locked. Inherited from dundas.view.controls.BasicAdapter.
	name	Gets or sets the name for this adapter to be used in script. This name may change, but must be unique. Inherited from dundas.view.controls.BasicAdapter.
	pageReadyActions	Gets or sets the page ready actions on this view. Inherited from dundas.view.controls.RepeaterAdapter.
	parentDefinition	Gets a value for the parent definition if this view is a template and has been loaded. This is a convenience property only set when the template is in-use by a dashboard, and has been loaded, and is not saved. Inherited from dundas.view.controls.CanvasAdapter.
	parentSubCanvas	Gets or sets a value storing a reference to the parent sub canvas, if in a subcanvas. Inherited from dundas.view.controls.CanvasAdapter.
	relativeFontSizeMax	Gets or sets a value for the relative font size maximum. Inherited from dundas.view.controls.CanvasAdapter.
	relativeFontSizeMin	Gets or sets a value for the relative font size minimum. Inherited from dundas.view.controls.CanvasAdapter.
	relativeFontSizeResizeStrength	Gets or sets a value indicating whether the factor at which relative fonts should adjust when the width of the dashboard is changed, and what that factor is. Inherited from dundas.view.controls.CanvasAdapter.
	resizeMode	Gets the value to indicate the resize mode. Inherited from dundas.view.controls.CanvasAdapter.
	resizeModeFit	Gets or sets the resize view mode fit. Inherited from dundas.view.controls.CanvasAdapter.
	site	Gets or sets the site that this component is a part of. Inherited from dundas.Component.
	templateAdapters	Gets or sets the adapters from the template. Inherited from dundas.view.controls.CanvasAdapter.
	templateCellHorizontalSpacing	Inherited from dundas.view.controls.CanvasAdapter.
	templateCells	Gets or sets the template cell of this dashboard or dashboard template Inherited from dundas.view.controls.CanvasAdapter.
	templateCellsHorizontalPadding	Get or sets the horizontal padding of the canvas to the template cells. Inherited from dundas.view.controls.CanvasAdapter.
	templateCellsVerticalPadding	Get or sets the vertical padding of the canvas to the template cells. Inherited from dundas.view.controls.CanvasAdapter.
	templateCellVerticalSpacing	Inherited from dundas.view.controls.CanvasAdapter.
	templateDefinition	Gets the dashboard template definition (the object from the template ID property). Inherited from dundas.view.controls.CanvasAdapter.
	templateId	Gets the dashboard template ID of the dashboard. Inherited from dundas.view.controls.CanvasAdapter.
	top	Gets or sets the top value. Inherited from dundas.view.controls.BasicAdapter.
	uniqueId	Gets or sets the unique ID of this component within the site. Inherited from dundas.Component.
	width	Gets or sets the width value. Inherited from dundas.view.controls.BasicAdapter.

Methods

	Name	Description
	addAdapters	Adds the given adapter to the canvas. Inherited from dundas.view.controls.CanvasAdapter.
	addLayers	Add layers to the report. Inherited from dundas.view.controls.CanvasAdapter.
	applyDefaultTheme	Applies the default application theme, if one is set, to either the whole Dashboard (if no adapters are specified), or do the specified adapters. Inherited from dundas.view.controls.RepeaterAdapter.
	applyTheme	Applies the given theme object to this View. Inherited from dundas.view.controls.RepeaterAdapter.
	attach	Attaches the container of this adapter to the target element. Inherited from dundas.view.controls.BasicAdapter.
	createDelegate	Helper for creating delegate functions. Inherited from dundas.Component.
	createTimeout	Creates a timeout. Inherited from dundas.Component.
	createViewModel	Create a view model of this adapter Inherited from dundas.view.controls.CanvasAdapter.
	detachTemplate	Detach the template, copy all template's content to the dashboard, and remove the template Inherited from dundas.view.controls.CanvasAdapter.
	dispatch	Dispatches a call by creating a delegate and running it right away on a timer. Inherited from dundas.Component.
	dispose	Disposes the component. Inherited from dundas.Component.
	fromJObject	Applies the property values from a plain object created from JSON to the properties of this instance. Inherited from Class.
	generateNextAdapterName	Generate the next available adapter name by seeing what adapter is present on the canvas. Inherited from dundas.view.controls.CanvasAdapter.
	generateNextGroupName	Generate the next available group name by seeing what group is present on the canvas. Inherited from dundas.view.controls.CanvasAdapter.
	generateNextRepeaterGroupName	Generates the next available group name by seeing what groups are present in the model. Inherited from dundas.view.controls.RepeaterAdapter.
	getAdapterById	Gets the requested adapter by ID. Inherited from dundas.view.controls.CanvasAdapter.
	getAdapterOrTemplateAdapterById	Gets the requested adapter by ID, or an adapter in the template with this ID. Inherited from dundas.view.controls.CanvasAdapter.
	getAdapters	Gets a read-only array of the adapters currently on the report. Inherited from dundas.view.controls.CanvasAdapter.
	getAdaptersAndTemplateAdapters	Gets a read-only array of the adapters currently on the canvas, along with the template adapters (if any). Inherited from dundas.view.controls.CanvasAdapter.
	getBoundVisuals	Gets the available bound visuals for a given metric set binding. Inherited from dundas.view.controls.BasicAdapter.
	getContext	Gets the context from the adapter based on the given information. This context can be used to provide contextual toolbar and property grid experiences. Inherited from dundas.view.controls.BasicAdapter.
	getContextualCommands	Gets the contextual toolbar commands. Inherited from dundas.view.controls.BasicAdapter.
	getControlProperties	Called to get the object with the list of properties on the root control, or any sub-element of the control. Inherited from dundas.view.controls.BasicAdapter.
	getLegendAdapters	Gets the legend adapters that are on the same canvas as this adapter. Inherited from dundas.view.controls.CanvasAdapter.
	getMetricSetBindingById	Gets the requested metric set binding on the given adapter ID by ID. Inherited from dundas.view.controls.RepeaterAdapter.
	getService	Gets the requested service. Inherited from dundas.Component.
	getSupportedSettings	Gets the settings for the supported operations of this adapter. Implementers of this function should call this._super() first to get the default settings. Inherited from dundas.view.controls.BasicAdapter.
	getTemplate	Gets the dashboard template of this dashboard. Inherited from dundas.view.controls.CanvasAdapter.
	getTemplateAdapters	Gets the adapters of the template. Inherited from dundas.view.controls.CanvasAdapter.
	getTemplateCellById	Retrieves a template cell adapter by its ID. Inherited from dundas.view.controls.CanvasAdapter.
	getTemplateCells	Get the template cells.
	getViewParametersAffectingAdapter	Gets the view parameters affecting the specified adapter. Inherited from dundas.view.controls.RepeaterAdapter.
	hideSimplePropertyPanel	Hides the simple property panel. Inherited from dundas.view.controls.BasicAdapter.
	invalidateBrushViewParameter	Informs all adapters that the brush view parameter has changed. This must be called after modifying the brushViewParameter property, otherwise no update will occur. Inherited from dundas.view.controls.RepeaterAdapter.
	load	Loads the designer.
	onBeforeExport	Called when the view should raise the before export events. Inherited from dundas.view.controls.CanvasAdapter.
	onDOMDetach	Called when the adapter is detached from the DOM. Inherited from dundas.view.controls.BasicAdapter.
	onDOMReattach	Called when the adapter is reattached to the DOM. Inherited from dundas.view.controls.BasicAdapter.
	onLoaded	Called when the adapter is loaded and set up. The control should be set up by the adapter now and added to the container element. Implementers of this method must call this._super() at the end if they want actions and events to be automatically set up. Inherited from dundas.view.controls.BasicAdapter.
	onLoading	Called when the view should raise the loading events which occur before the canvas actually loads. Inherited from dundas.view.controls.CanvasAdapter.
	onMetricSetBindingChanged	Updates the repeater based on changes to the adapter's metric set. Inherited from dundas.view.controls.RepeaterAdapter.
	onMetricSetChanged	Takes actions required in response to a metric set change. This may result in modifications to this and other metric sets. Inherited from dundas.view.controls.RepeaterAdapter.
	onPageReady	Called when the view should raise the page ready events which occurs after a page is loaded. Inherited from dundas.view.controls.RepeaterAdapter.
	onPropertyChanged	Called when a property is changed on the adapter. This will not be called during a bulk change, as those properties are set via direct sets to avoid this event firing. Inherited from dundas.view.controls.RepeaterAdapter.
	onReady	Called when the view should raise the ready events. Inherited from dundas.view.controls.CanvasAdapter.
	onResize	Called when the view should raise the resize events. Inherited from dundas.view.controls.CanvasAdapter.
	refreshPropertyGridWithContext	Refresh property grid, if necessary, while keeping the last known context and state of the property grid. Inherited from dundas.view.controls.BasicAdapter.
	removeAdapters	Removes the given adapter from the canvas. Inherited from dundas.view.controls.CanvasAdapter.
	removeLayers	Remove layers from the report. Inherited from dundas.view.controls.CanvasAdapter.
	render	Prepares the design view.
	setTemplate	Sets the given dashboard template to be the template of this adapter. Inherited from dundas.view.controls.CanvasAdapter.
	setTemplateCells	Set the template cells of this report. Inherited from dundas.view.controls.CanvasAdapter.
	showSimplePropertyPanel	Shows the simple properties panel. Inherited from dundas.view.controls.BasicAdapter.
	subscribeDisposedEvent	Subscribe a handler for the disposed event. Inherited from dundas.view.controls.BasicAdapter.
	subscribeTemplateCleared	Subscribe to the template cleared event. Inherited from dundas.view.controls.CanvasAdapter.
	suppressNextPropertyChangedEvent	Prevents property changed event to be fired next time a property is set. Inherited from dundas.view.controls.BasicAdapter.
	tempDetach	Temporarily detaches the container of the adapter off the DOM, all events are retained. Inherited from dundas.view.controls.BasicAdapter.
	toJSON	Implementation for toJSON to return an object that will include this class's prototype property values when stringified. Inherited from Class.