MAIDR JavaScript API
    Preparing search index...

    Interface PowerBIMetadataColumn

    Metadata for one column of a data view (powerbi.DataViewMetadataColumn).

    interface PowerBIMetadataColumn {
        displayName: string;
        queryName?: string;
        roles?: Readonly<Record<string, boolean | undefined>>;
        type?: PowerBIValueTypeDescriptor;
        isMeasure?: boolean;
        groupName?: PowerBIPrimitiveValue;
        index?: number;
    }
    Index

    Properties

    displayName queryName? roles? type? isMeasure? groupName? index?

    Properties

    displayName: string

    The field's caption, as the report author sees it in the field well.

    queryName?: string

    The field's query name; stable across refreshes, used for withMeasure.

    roles?: Readonly<Record<string, boolean | undefined>>

    The data roles, declared in the visual's capabilities.json, that this field is bound to. A field dropped in two wells carries both.

    type?: PowerBIValueTypeDescriptor
    isMeasure?: boolean

    Whether the column is a measure rather than a grouping.

    groupName?: PowerBIPrimitiveValue

    The series value this column belongs to, when the values were grouped by a series (legend) field. Absent for an ungrouped value column.

    index?: number

    The column's position in the query's select list.

    Settings

    Member Visibility

    On This Page

    Properties