Class AstTabularKpiNode
Tabular KPI objects correspond directly to SQL Server Analysis Services (SSAS) Tabular Model Key Performance Indicators (KPIs), which allow measures to be annotated with information about targets, statuses, and trends for use in analytics.
Namespace: Varigence.Languages.Biml.Tabular
Assembly: Biml.dll
C#
public class AstTabularKpiNode : AstNode, IBindableItem, IGetJsonProvider, IFrameworkItem, IValidationInfo
Inheritance AstNode
-
Implements
Varigence.Utility.Collections.IVulcanCollectionParent, Varigence.Utility.ComponentModel.IVulcanNotifyPropertyChanged, Varigence.Utility.ComponentModel.IPropertyChangeNotificationTarget, System.ComponentModel.INotifyPropertyChanged, Varigence.Utility.Xml.IXObjectMappingProvider, System.ComponentModel.IDataErrorInfo,
Constructors
| Constructors | Description |
|---|---|
| AstTabularKpiNode(IFrameworkItem) | Initializes a new instance of the AstTabularKpiNode class with the specified parent node. |
Fields
| Fields | Description |
|---|---|
| IsScopeImported |
Properties
| Properties | Description |
|---|---|
| Description | Specifies a user facing description that will be used for this tabular KPI in reporting client tools. |
| DescriptionDefaultValue | Gets the default value for the Description property |
| FriendlyTypeNameStatic | Gets the friendly name of the type of this node |
| StatusDescription | Specifies a user facing description that will be used for the status of this tabular KPI in reporting client tools. |
| StatusDescriptionDefaultValue | Gets the default value for the StatusDescription property |
| StatusExpression | Specifies the DAX expression that should be used to calculate an integer indicating which item from the status graphic icon set to use in client reporting tools. For graphics that contain 3 icons, the return value should be 1, 0, or -1 for statuses in descending order of positivity. For graphics that contain 3 icons, the return value should be 1, 0.5, 0, -0.5, or -1 for statuses in descending order of positivity. |
| StatusExpressionDefaultValue | Gets the default value for the StatusExpression property |
| StatusGraphic | Specifies the icon set to use for status graphics in client reporting tools. |
| StatusGraphicDefaultValue | Gets the default value for the StatusGraphic property |
| TargetDescription | Specifies a user facing description that will be used for the target of this tabular KPI in reporting client tools. |
| TargetDescriptionDefaultValue | Gets the default value for the TargetDescription property |
| TargetExpression | Specifies the DAX expression that should be used to determine the target or goal value for the KPI. |
| TargetExpressionDefaultValue | Gets the default value for the TargetExpression property |
| TargetFormatString | Specifies the format to be used when presenting the value of the target for this KPI in reporting client tools. |
| TargetFormatStringDefaultValue | Gets the default value for the TargetFormatString property |
| TrendDescription | Specifies a user facing description that will be used for the trend of this tabular KPI in reporting client tools. |
| TrendDescriptionDefaultValue | Gets the default value for the TrendDescription property |
| TrendExpression | Specifies the DAX expression that should be used to calculate an integer indicating which item from the trend graphic icon set to use in client reporting tools. For graphics that contain 3 icons, the return value should be 1, 0, or -1 for trends in descending order of positivity. For graphics that contain 3 icons, the return value should be 1, 0.5, 0, -0.5, or -1 for trends in descending order of positivity. |
| TrendExpressionDefaultValue | Gets the default value for the TrendExpression property |
| TrendGraphic | Specifies the icon set to use for trend graphics in client reporting tools. |
| TrendGraphicDefaultValue | Gets the default value for the TrendGraphic property |
| Guid | |
| Annotations | This is a collection of annotation items that can be used to specify documentation, tags, or other information. Annotations are particularly useful for storing information about nodes that can be used by BimlScript code. |
| ObjectTag | This property provides a general purpose storage mechanism for .NET objects to be associated with AstNode objects. It supplements the annotation system, which is intended for use with string-based metadata. |
| BimlFile | This value specifies the BimlFile in which the Biml code that defines AstNode resides. |
| ItemLabel | Gets a label that can be used to identify this node |
| ParentItem | This value specifies the parent of the current node. All nodes must have a valid parent in the Biml framework, except for the root node. |
Methods
| Methods | Description |
|---|---|
| BindingScopeBoundaries() | Retrieves the permitted scope boundaries to bind references from this node. |
| Duplicate() | Creates a duplicate of the current node |
| Duplicate(IFrameworkItem) | Creates a duplicate of the current node with the specified parent item |
| GetDefaultValue(String) | Retrieves the default value for the property with the name propertyName |
| GetDefaultValue<T>(String) | Retrieves the default value for the property with the name propertyName |
| GetSchemaLocalName() | Retrieves the local XML element name that corresponds to this node in Biml code. |
| StructureEquals(Object) | Compares this node to the provided object to determine if all defined children and references are equal. |
| FirstChildOfType<TChild>() | Gets the first defined descendant node of the specified type |
| RemoveFromParent() | Removes this node definition from its parent |
| DefinedAstNodes() | Retrieves a collection of nodes that have been defined as direct children of the current node. |
| GetJson() | Generates a JavaScript Object Notation (JSON) representation of the current node |
| GetExternalJson() | Generates a JavaScript Object Notation (JSON) representation of the current node |
| GetJson(Boolean, Boolean, Boolean, Boolean, Boolean) | Generates a JavaScript Object Notation (JSON) representation of the current node |
| GetXObjectName() | Gets the fully qualified XML element name for this node in the code document. |
| FirstParent<TAstNode>() | Retrieves the first parent or ancestor node of the specified type |
| FirstParent<TAstNode>(Type) | Retrieves the first parent or ancestor node of the specified type with the specified custom attribute type |
| FirstThisOrParent<TAstNode>() | Retrieves the first parent or ancestor node of the specified type, including this node |
| IsDirectAncestor(IFrameworkItem) | Retrieves a value indicating whether the specified node is a direct ancestor of this node. |
| AncestorDistance(IFrameworkItem) | Retrieves the number of steps between this node and the nearest shared ancestor with the specified relative node. |
| FirstThisOrParent<TAstNode>(Type) | Retrieves the first parent or ancestor node (including this node) of the specified type with the specified custom attribute type |
| AllDefinedSuccessors() | Retrieves the collection of all nodes defined as a child of this or any successor node or the current node |
| AllDefinedSuccessors(Boolean) | Retrieves the collection of all nodes defined as a child of this or any successor node or optionally the current node |
| OnNotificationTargetPropertyChanged(String) | |
| OnScopeBoundaryChanged(IScopeBoundary, IScopeBoundary) | |
| AddParseableChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>) | |
| RemoveParseableChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>) | |
| AddScopeBoundaryChangedEventListener(IFrameworkItem, EventHandler<VulcanPropertyChangedEventArgs>) | |
| RemoveScopeBoundaryChangedEventListener(IFrameworkItem, EventHandler<VulcanPropertyChangedEventArgs>) | |
| AddParsePendingChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>) | |
| RemoveParsePendingChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>) | |
| AddFromTemplateChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>) | |
| RemoveFromTemplateChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>) | |
| GetAllItemsReferencedByDefinedSuccessors() | Builds a list of all items referenced by this node and its successors. Each tuple in the returned list represents a FrameworkItemReference. The first item is the ReferencingItem, the second item is the property name, and the third item is the ReferencedItem. |
| ParseSelf(XElement, ParserContext) | |
| ParseNameValueMapping(XElement) | |
| BindReference(SymbolTable, String, Boolean, String, Int32, Boolean) |