ViewData Class

Base data contract class for returning a View through the REST API.
Inheritance Hierarchy

Namespace:  Dundas.BI.WebApi.Models
Assembly:  Dundas.BI.WebApiCore (in Dundas.BI.WebApiCore.dll) Version: 2.0.0.0 (24.3.0.1000)
Syntax
[DataContractAttribute]
public class ViewData : EntityBaseData

The ViewData type exposes the following members.

Constructors
  NameDescription
Public methodViewData
Initializes a new instance of the ViewData class.
Top
Properties
  NameDescription
Public propertyAdapters
Gets the Adapters.
Public propertyBackground
Gets or sets the background.
Public propertyBeforeExportActions
Gets the before export actions.
Public propertyBrushViewParameterId
Gets or sets the ID of the brush view parameter.
Public propertyChatflowId
Gets or sets the chatflow ID for the chatbot.
Public propertyCheckedOutTo
Gets information about the account to which the object is checked out.
(Inherited from FileData.)
Public propertyChildCount
Gets the number of direct children contained in the entry.
(Inherited from FileData.)
Public propertyCodeLibraryIds
Gets a collection containing the IDs of any code libraries directly referenced by the view.
Public propertyCreatedBy
Gets the account information for the user which created the entry.
(Inherited from FileData.)
Public propertyCreatedTime
Gets the time, in coordinated universal time (UTC), at which the entry was created.
(Inherited from FileData.)
Public propertyCurrentRevision
Gets the highest revision number associated with this file.
(Inherited from FileData.)
Public propertyDescription
Gets an optional description associated with the entry.
(Inherited from FileData.)
Public propertyDisabledApplicationPrivileges
Gets the disabled application privileges. This is a list of each application privilege ID which should be disabled regardless of the user's application-wide privilege.
Public propertyEffectiveCallerPrivileges
Gets the effective caller privileges so the UI can do checks based on this.
(Inherited from FileData.)
Public propertyExportTimeout
Gets or sets the export timeout override length in seconds.
Public propertyFiles
Gets the files contained in the entry.
(Inherited from FileData.)
Public propertyFolders
Gets the folders contained in the entry.
(Inherited from FileData.)
Public propertyFontColor
Gets or sets the font color.
Public propertyFontFamily
Gets or sets the font family.
Public propertyFontSize
Gets or sets the size of the font.
Public propertyFontStyle
Gets or sets the font style.
Public propertyFontVariant
Gets or sets the font variant.
Public propertyFontWeight
Gets or sets the font weight.
Public propertyFriendlyFullName
Gets the full path of the entry (friendly).
(Inherited from FileData.)
Public propertyFriendlyLocation
Gets the location of the entry (friendly representation).
(Inherited from FileData.)
Public propertyFriendlyLocationElements
Gets a read-only list of distinct path elements which compose FriendlyLocation.
(Inherited from FileData.)
Public propertyFriendlyName
Gets the name of the entry (friendly representation).
(Inherited from FileData.)
Public propertyFullName
Gets the full path of the entry.
(Inherited from FileData.)
Public propertyHeight
Gets or sets the height.
Public propertyId
Gets the unique identifier of the entry.
(Inherited from FileData.)
Public propertyIgnoreAspectRatioOnResize
Gets or sets a value indicating whether this view will ignore its aspect ratio when in scale view mode or resize view mode.
Public propertyInheritedTags
Gets the inherited tags, if there are any.
(Inherited from FileData.)
Public propertyInitialViewOptions
Gets or sets the initial view options, such as it should start full screen. This option can be overridden by the overrides.
Public propertyIsAdhoc
Gets a value indicating whether this dashboard is an ad hoc dashboard. This property is set to the File, and as such, applies to all instances (not just the checked out version) of this object.
Public propertyIsAutomaticBrushingDisabled
Gets or sets a value indicating whether automatic data brushing is disabled on this view and only custom interactions passing values to the brush view parameter trigger data brushing.
Public propertyIsCheckedOut
Gets a value indicating whether the file is checked out.
(Inherited from FileData.)
Public propertyIsCheckedOutToCaller
Gets a value indicating whether the file is checked out to caller.
(Inherited from FileData.)
Public propertyIsCustomLocalizationApplied
Gets or sets a value indicating whether the custom localization applied on this entity.
(Inherited from EntityBaseData.)
Public propertyIsInactive
Gets a value indicating whether the file is inactive.
(Inherited from FileData.)
Public propertyIsProtected
Gets a value indicating whether the entry is protected.
(Inherited from FileData.)
Public propertyIsRecycled
Gets a value indicating whether the entry is recycled.
(Inherited from FileData.)
Public propertyIsSubentry
Gets a value indicating whether the entry is contained by a File.
(Inherited from FileData.)
Public propertyIsTemplate
Gets a value indicating whether this dashboard is a template. This property is set to the File, and as such, applies to all instances (not just the checked out version) of this object.
Public propertyIsTemporary
Gets a value indicating whether the entry resides under a temporary folder.
(Inherited from FileData.)
Public propertyIsTransient
Gets a value indicating whether the file is transient.
(Inherited from FileData.)
Public propertyLastCheckedInTime
Gets the time when the file was last checked in.
(Inherited from FileData.)
Public propertyLastModifiedTime
Gets the time, in coordinated universal time (UTC), at which the entry was last modified.
(Inherited from FileData.)
Public propertyLayers
Gets the layers.
Public propertyLoadingActions
Gets the loading actions.
Public propertyLocation
Gets the location of the entry.
(Inherited from FileData.)
Public propertyMetadata
Gets arbitrary metadata associated with the entry.
(Inherited from FileData.)
Public propertyName
Gets the name of the entry.
(Inherited from FileData.)
Public propertyObjectType
Gets the type of the entry.
(Inherited from FileData.)
Public propertyOverwrite
Gets or sets a value indicating whether the file should be overwritten if the file was already created.
(Inherited from FileData.)
Public propertyParameterAdapters
Gets the collection of global parameter adapters that are shown in the parameter bar when viewing.
Public propertyParentId
Gets the ID of the item's parent.
(Inherited from FileData.)
Public propertyPrimaryEntryId
Gets the ID of the primary object which contains the entry.
(Inherited from FileData.)
Public propertyPrivilegeInheritanceBehavior
Gets the privilege inheritance behavior.
(Inherited from FileData.)
Public propertyPrivileges
Gets the entry's privilege assignments.
(Inherited from FileData.)
Public propertyProjectId
Gets the ID of the project containing the entry.
(Inherited from FileData.)
Public propertyReadyActions
Gets the ready actions.
Public propertyRelativeFontSizeMax
Gets or sets the minimum font size relative font size is limited to.
Public propertyRelativeFontSizeMin
Gets or sets the minimum font size relative font size is limited to.
Public propertyRelativeFontSizeResizeStrength
Gets or sets the strength for resizing relative font size.
Public propertyRepeaterModel
Gets or sets the repeater model.
Public propertyResizeActions
Gets the resize actions.
Public propertyResizeMode
Gets or sets the resize mode.
Public propertyResizeModeFit
Gets or sets the resize mode fit. This only applies when ResizeMode is Resize.
Public propertyRevision
Gets the revision of this instance.
(Inherited from EntityBaseData.)
Public propertySubtype
Gets or sets the type-specific sub-type of the entry.
(Inherited from FileData.)
Public propertyTags
Gets a collection of explicit tags associated with the entry.
(Inherited from FileData.)
Public propertyTemplateCellHorizontalSpacing
Gets or sets the template cell horizontal spacing.
Public propertyTemplateCells
Gets the template cells.
Public propertyTemplateCellsHorizontalPadding
Get or sets the horizontal padding of the canvas to the template cells.
Public propertyTemplateCellsVerticalPadding
Get or sets the vertical padding of the canvas to the template cells.
Public propertyTemplateCellVerticalSpacing
Gets or sets the template cell vertical spacing.
Public propertyTemplateDefinition
Gets or sets the template definition. This will only be populated if TemplateId is non-empty.
Public propertyTemplateId
Gets or sets the ID of the template.
Public propertyTenantId
Gets the ID of the tenant associated with the entry.
(Inherited from FileData.)
Public propertyUIClassName
Gets or sets the name of the UI class (used for auto de-serialization).
(Inherited from BaseDataContract.)
Public propertyUndoContext
If available, the current undo context for the entity.
(Inherited from EntityBaseData.)
Public propertyVersion
Gets or sets the version of the entity.
Public propertyViewParameters
Gets the view parameters.
Public propertyViewSubtype
Gets or sets a value indicating the subtype of the view. This property is set to the File, and as such, applies to all instances (not just the checked out version) of this object.
Public propertyViewType
Gets the view type.
Public propertyWarnings
Gets the warnings for the current instance, as well as for any dependency objects.
(Inherited from FileData.)
Public propertyWidth
Gets or sets the width.
Top
Methods
  NameDescription
Public methodStatic memberFromDataContractMappings
The mapping from ViewData to View.
Public methodStatic memberToDataContractMappings
The mapping from View to ViewData.
Top
Extension Methods
  NameDescription
Public Extension MethodSetUIClassName(FileSystemEntry)Overloaded.
Sets the name of the file data UI class.
(Defined by ModelDataExtensions.)
Public Extension MethodSetUIClassName(View)Overloaded.
Sets the name of the view data UI class.
(Defined by ModelDataExtensions.)
Top
See Also