v2.2.0
Core Module Rdl ActiveReportsJS API Module

Rdl Module

Type aliases

Action

Action: { BookmarkLink?: undefined | string; Drillthrough?: undefined | { Parameters?: { ParameterName: string; Value?: undefined | string }[]; ReportName?: undefined | string }; Hyperlink?: undefined | string }

Represents a hyperlink, bookmark link, or drillthrough action that is associated with a report item. Visit Interactive Reports for more information.

Type declaration

  • Optional BookmarkLink?: undefined | string

    Gets or sets the ID of the bookmark that is located in a report to go to when the containing report item for this action is clicked

  • Optional Drillthrough?: undefined | { Parameters?: { ParameterName: string; Value?: undefined | string }[]; ReportName?: undefined | string }

    Indicates a drillthrough report to be executed and viewed by clicking the containing report item for this action.

  • Optional Hyperlink?: undefined | string

    Gets or sets a hyperlink that is viewed by clicking the containing report item for this action

BackgroundImage

BackgroundImage: { BackgroundRepeat?: undefined | string; MIMEType?: undefined | string; Source?: "External" | "Embedded" | "Database"; Value?: undefined | string }

Represents the background images for a report item.

Type declaration

  • Optional BackgroundRepeat?: undefined | string

    Gets or sets a value indicating how a background image fills the available space within its container.

    value

    "Repeat" specifies that the image repeats both horizontally and vertically to fill the space.

    value

    "RepeatX" specifies that the image repeats horizontally to fill the space.

    value

    "RepeatY" specifies that the image repeats vertically to fill the space.

    value

    "NoRepeat" specifies that the image does not repeat to fill the space.

  • Optional MIMEType?: undefined | string

    Get or sets the image format of a background image. Supported values are "image/jpeg", "image/gif", "image/png", and "image/svg+xml".

  • Optional Source?: "External" | "Embedded" | "Database"

    Gets or sets the type of source that is associated with a background image

    value

    "External" indicates that the Value property specifies the location of an image

    value

    "Embedded" indicates that the Value property specifies the name of an embedded image within a report

    value

    "Database" indicates that the Value property specifies an expression (such as a field in the database) that evaluates to the binary data for an image

  • Optional Value?: undefined | string

    Gets or sets either the location or the actual data of a background image, depending on the value of the BackgroundImage.Source

BandedList

BandedList: { Bookmark?: undefined | string; ConsumeWhiteSpace?: undefined | false | true; DataSetName?: undefined | string; Details?: undefined | { CanGrow?: undefined | false | true; CanShrink?: undefined | false | true; Height?: undefined | string; KeepTogether?: undefined | false | true; Name?: undefined | string; PageBreak?: "None" | "Start" | "End" | "StartAndEnd" | "Between"; ReportItems?: ReportItem[]; Visibility?: Visibility }; Filters?: Filter[]; FixedHeight?: undefined | string; FixedWidth?: undefined | string; Footer?: BandedListFooter; Groups?: BandedListGroup[]; Header?: BandedListHeader; Height?: undefined | string; KeepTogether?: undefined | false | true; Label?: undefined | string; Left?: undefined | string; Name: string; NewSection?: undefined | false | true; OverflowName?: undefined | string; PageBreak?: "None" | "Start" | "End" | "StartAndEnd" | "Between"; PreventOrphanedFooter?: undefined | false | true; PreventOrphanedHeader?: undefined | false | true; ToolTip?: undefined | string; Top?: undefined | string; Type: "bandedlist"; Visibility?: Visibility; Width?: undefined | string; ZIndex?: undefined | number }

Represents properties of a Banded List in a report

Type declaration

  • Optional Bookmark?: undefined | string

    Gets or sets a value or an expression indicating the Id of a Banded List for a Jump To Bookmark interactivity action.

  • Optional ConsumeWhiteSpace?: undefined | false | true

    Gets or sets a value indicating whether all whitespace in a Banded List should be consumed when contents grow

  • Optional DataSetName?: undefined | string

    Gets or sets the name of the dataset to use to bind data to a Banded List.

  • Optional Details?: undefined | { CanGrow?: undefined | false | true; CanShrink?: undefined | false | true; Height?: undefined | string; KeepTogether?: undefined | false | true; Name?: undefined | string; PageBreak?: "None" | "Start" | "End" | "StartAndEnd" | "Between"; ReportItems?: ReportItem[]; Visibility?: Visibility }

    Gets or sets a value indicating the collection of detail bands in a Banded List.

  • Optional Filters?: Filter[]

    Gets or sets a value indicating a collection of filters to be applied to the data for each row of a Banded List

    see

    Filter

  • Optional FixedHeight?: undefined | string

    Gets or sets a value in Length units indicating the fixed height of a Banded List

  • Optional FixedWidth?: undefined | string

    Gets or sets a value in Length units indicating the fixed width of a Banded List

  • Optional Footer?: BandedListFooter

    Gets or sets a value indicating the collection of footer bands in a BandedList.

    see

    BandedListFooter

  • Optional Groups?: BandedListGroup[]

    Gets or sets a value indicating the collection of banded list groups consisting of group expressions, group headers, and group footers for a Banded List.

    see

    BandedListGroup

  • Optional Header?: BandedListHeader

    Gets or sets a value indicating the collection of header bands in a BandedList.

    see

    BandedListHeader

  • Optional Height?: undefined | string

    Gets or sets a value in Length units indicating the height of a Banded List

  • Optional KeepTogether?: undefined | false | true

    Gets or sets a value indicating whether the entire contents of a Banded List should be kept together on one Page if possible

  • Optional Label?: undefined | string

    Gets or sets a value or an expression indicating the text associated with a Banded List that appears in the Report Map and Table of Contents

  • Optional Left?: undefined | string

    Gets or sets a value in Length units indicating the distance of a Banded List from the left of the banded list's container

  • Name: string

    Gets or sets a unique identifier for a Banded List

  • Optional NewSection?: undefined | false | true

    Gets or sets a value indicating a Banded List has its page numbering

  • Optional OverflowName?: undefined | string

    Gets or sets a value indicating the name of the overflow place holder for a fixed Banded List layout

  • Optional PageBreak?: "None" | "Start" | "End" | "StartAndEnd" | "Between"

    Gets or sets a value indicating the location of a page breaks generated by a Banded List

  • Optional PreventOrphanedFooter?: undefined | false | true

    Gets or sets a value indicating whether a lonely Banded List footer should be prevented.

  • Optional PreventOrphanedHeader?: undefined | false | true

    Gets or sets a value indicating whether a lonely Banded List header should be prevented.

  • Optional ToolTip?: undefined | string

    Gets or sets a value or an expression indicating the text displayed when a report reader hovers over a Banded List at preview time

  • Optional Top?: undefined | string

    Gets or sets a value in Length units indicating the distance of a Banded List from the top of the banded list's container

  • Type: "bandedlist"

    Should be set to "bandedlist"

  • Optional Visibility?: Visibility

    Gets or sets a value indicating whether a Banded List is hidden

    see

    Visibility

  • Optional Width?: undefined | string

    Gets or sets a value in Length units indicating the width of a Banded List

  • Optional ZIndex?: undefined | number

    Gets or sets a value indicating the stack order of a Banded List

BandedListFooter

BandedListFooter: { CanGrow?: undefined | false | true; CanShrink?: undefined | false | true; Height?: undefined | string; KeepTogether?: undefined | false | true; Name?: undefined | string; PageBreak?: "None" | "Start" | "End" | "StartAndEnd" | "Between"; PrintAtBottom?: undefined | false | true; RepeatOnNewPage?: undefined | false | true; ReportItems?: ReportItem[]; Visibility?: Visibility }

Represents properties of the footer band of a Banded List

see

BandedList

Type declaration

  • Optional CanGrow?: undefined | false | true

    Gets or sets a value indicating whether the height of the Footer band can increase to match its contents

  • Optional CanShrink?: undefined | false | true

    Gets or sets a value indicating whether the height of the Footer band can decrease to match its contents

  • Optional Height?: undefined | string

    Gets or sets a value in Length units indicating the height of the Footer band in a Banded List

  • Optional KeepTogether?: undefined | false | true

    Gets or sets a value indicating whether the entire contents of the Footer band should be kept together on one Page if possible

  • Optional Name?: undefined | string

    Gets or sets a unique identifier for the Footer band

  • Optional PageBreak?: "None" | "Start" | "End" | "StartAndEnd" | "Between"

    Gets or sets a value indicating the location of a page breaks generated by the Header band

  • Optional PrintAtBottom?: undefined | false | true

    Gets or sets a value indicating whether a banded list footer always prints at the bottom of the page

  • Optional RepeatOnNewPage?: undefined | false | true

    Gets or sets a value indicating whether rendered footer bands are repeated on every Page where the footer’s parent Banded List is rendered

  • Optional ReportItems?: ReportItem[]

    Gets or sets a value indicating a collection of reports item that are contained within the Footer band of a Banded List

    see

    ReportItem

  • Optional Visibility?: Visibility

    Gets or sets a value indicating whether the Footer band is hidden

    see

    Visibility

BandedListGroup

BandedListGroup: { Footer?: BandedListFooter; Group?: Grouping; Header?: BandedListHeader; KeepTogether?: undefined | false | true; PreventOrphanedFooter?: undefined | false | true; PreventOrphanedHeader?: undefined | false | true; SortExpressions?: SortExpression[]; Visibility?: Visibility }

Represents a group in a Banded List

see

BandedList

Type declaration

  • Optional Footer?: BandedListFooter

    Gets or sets a value indicating a collection of bands in a Banded List Group Footer.

    see

    BandedListHeader

  • Optional Group?: Grouping

    Gets or sets a value indicating expressions by which to group the data in a Banded List Group.

    see

    Grouping

  • Optional Header?: BandedListHeader

    Gets or sets a value indicating a collection of bands in a Banded List Group Header.

    see

    BandedListHeader

  • Optional KeepTogether?: undefined | false | true

    Gets or sets a value indicating whether the entire contents of a Banded List Group should be kept together on one Page if possible

  • Optional PreventOrphanedFooter?: undefined | false | true

    Gets or sets a value indicating whether a lonely Banded List Group Footer should be prevented.

  • Optional PreventOrphanedHeader?: undefined | false | true

    Gets or sets a value indicating whether a lonely Banded List Group Header should be prevented.

  • Optional SortExpressions?: SortExpression[]

    Gets or sets a value indicating a collection of expressions by which to sort the data in a Banded List Group.

    see

    SortExpression

  • Optional Visibility?: Visibility

    Gets or sets a value indicating the presence of a Banded List Group.

    see

    Visibility

BandedListHeader

BandedListHeader: { CanGrow?: undefined | false | true; CanShrink?: undefined | false | true; Height?: undefined | string; KeepTogether?: undefined | false | true; Name?: undefined | string; PageBreak?: "None" | "Start" | "End" | "StartAndEnd" | "Between"; RepeatOnNewPage?: undefined | false | true; ReportItems?: ReportItem[]; Visibility?: Visibility }

Represents properties of the header band of a Banded List

see

BandedList

Type declaration

  • Optional CanGrow?: undefined | false | true

    Gets or sets a value indicating whether the height of the Header band can increase to match its contents

  • Optional CanShrink?: undefined | false | true

    Gets or sets a value indicating whether the height of the Header band can decrease to match its contents

  • Optional Height?: undefined | string

    Gets or sets a value in Length units indicating the height of the Header band in a Banded List

  • Optional KeepTogether?: undefined | false | true

    Gets or sets a value indicating whether the entire contents of the Header band should be kept together on one Page if possible

  • Optional Name?: undefined | string

    Gets or sets a unique identifier for the Header band

  • Optional PageBreak?: "None" | "Start" | "End" | "StartAndEnd" | "Between"

    Gets or sets a value indicating the location of a page breaks generated by the Header band

  • Optional RepeatOnNewPage?: undefined | false | true

    Gets or sets a value indicating whether rendered header bands are repeated on every Page where the header’s parent Banded List is rendered

  • Optional ReportItems?: ReportItem[]

    Gets or sets a value indicating a collection of reports item that are contained within the Header band of a Banded List

    see

    ReportItem

  • Optional Visibility?: Visibility

    Gets or sets a value indicating whether the Header band is hidden

    see

    Visibility

Barcode

Barcode: { BarHeight?: undefined | string; Bookmark?: undefined | string; CaptionGrouping?: undefined | false | true; CaptionLocation?: "None" | "Above" | "Below"; CheckSum?: undefined | false | true; Code49Options?: BarcodeCode49Options; DataMatrixOptions?: BarcodeDataMatrixOptions; Gs1CompositeOptions?: BarcodeGs1CompositeOptions; Height?: undefined | string; InvalidBarcodeText?: undefined | string; Label?: undefined | string; Left?: undefined | string; NWRation?: undefined | number; Name: string; NarrowBarWidth?: undefined | string; Pdf417Options?: BarcodePdf417Options; QrCodeOptions?: BarcodeQrCodeOptions; QuietZone?: undefined | { Bottom?: undefined | string; Left?: undefined | string; Right?: undefined | string; Top?: undefined | string }; Rotation?: undefined | string; Style?: undefined | { BackgroundColor?: undefined | string; Border?: BorderStyle; BottomBorder?: BorderStyle; Color?: undefined | string; FontFamily?: undefined | string; FontSize?: undefined | string; FontStyle?: undefined | string; FontWeight?: undefined | string; Format?: undefined | string; LeftBorder?: BorderStyle; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string; RightBorder?: BorderStyle; TextAlign?: undefined | string; TextDecoration?: undefined | string; TopBorder?: BorderStyle }; Symbology?: "None" | "Ansi39" | "Ansi39x" | "BC412" | "Codabar" | "Code_11" | "Code_128_A" | "Code_128_B" | "Code_128_C" | "Code_128auto" | "Code_2_of_5" | "Code_93" | "Code25intlv" | "Code39" | "Code39x" | "Code49" | "Code93x" | "DataMatrix" | "EAN_13" | "EAN_8" | "EAN128FNC1" | "GS1QRCode" | "HIBCCode128" | "HIBCCode39" | "IATA_2_of_5" | "IntelligentMail" | "IntelligentMailPackage" | "ISBN" | "ISMN" | "ISSN" | "ITF14" | "JapanesePostal" | "Matrix_2_of_5" | "MaxiCode" | "MicroPDF417" | "MicroQRCode" | "MSI" | "Pdf417" | "Pharmacode" | "Plessey" | "PostNet" | "PZN" | "QRCode" | "RM4SCC" | "RSS14" | "RSS14Stacked" | "RSS14StackedOmnidirectional" | "RSS14Truncated" | "RSSExpanded" | "RSSExpandedStacked" | "RSSLimited" | "SSCC_18" | "Telepen" | "UCCEAN128" | "UPC_A" | "UPC_E0" | "UPC_E1"; ToolTip?: undefined | string; Top?: undefined | string; Type: "barcode"; Value?: undefined | string; Visibility?: Visibility; Width?: undefined | string; ZIndex?: undefined | number }

Represents properties for a Barcode in a report

Type declaration

  • Optional BarHeight?: undefined | string

    Gets or sets a value in Length units indicating the height of the barcode's bars.

  • Optional Bookmark?: undefined | string

    Gets or sets a value or an expression indicating the Id of a Barcode for a Jump To Bookmark interactivity action.

  • Optional CaptionGrouping?: undefined | false | true

    Gets or sets a value indicating whether to add spaces between groups of characters in the caption to make long numbers easier to read.

  • Optional CaptionLocation?: "None" | "Above" | "Below"

    Gets or sets a value indicating the vertical alignment of the caption in a Barcode.

  • Optional CheckSum?: undefined | false | true

    Gets or sets a value indicating whether a barcode requires a checksum.

  • Optional Code49Options?: BarcodeCode49Options

    Gets or sets a value indicating options for a Code49 barcode

    see

    BarcodeCode49Options

  • Optional DataMatrixOptions?: BarcodeDataMatrixOptions

    Gets or sets a value indicating options for a DataMatrix barcode

    see

    BarcodeDataMatrixOptions

  • Optional Gs1CompositeOptions?: BarcodeGs1CompositeOptions

    Gets or sets a value indicating options for a GC1QRCode barcode

    see

    {@link BarcodeGs1CompositeOptions}

  • Optional Height?: undefined | string

    Gets or sets a value in Length units indicating the height of a Barcode

  • Optional InvalidBarcodeText?: undefined | string

    Gets or sets a value an expression indicating the text that shows in case a Barcode's value is invalid.

  • Optional Label?: undefined | string

    Gets or sets a value or an expression indicating the text associated with a Barcode that appears in the Report Map and Table of Contents

  • Optional Left?: undefined | string

    Gets or sets a value in Length units indicating the distance of a Barcode from the left of the barcode's container

  • Optional NWRation?: undefined | number

    Gets or sets a value indicating the multiple of the ratio between the narrow and wide bars in symbologies that contain bars in only two widths.

  • Name: string

    Gets or sets a unique identifier for a List

  • Optional NarrowBarWidth?: undefined | string

    Gets or sets a value in Length units indicating the width of the narrowest part of the barcode.

  • Optional Pdf417Options?: BarcodePdf417Options

    Gets or sets a value indicating options for a Pdf417 barcode

    see

    BarcodePdf417Options

  • Optional QrCodeOptions?: BarcodeQrCodeOptions

    Gets or sets a value indicating options for a QRCode barcode

    see

    {@link BarcodeQrCodeptions}

  • Optional QuietZone?: undefined | { Bottom?: undefined | string; Left?: undefined | string; Right?: undefined | string; Top?: undefined | string }

    Gets or sets a value indicating an area of blank space on each side of a barcode that tells the scanner where the symbology starts and stops.

  • Optional Rotation?: undefined | string

    Gets or sets the amount of rotation to use for the barcode. Supported values are

    value

    "Rotate90Degress"

    value

    "Rotate180Degress"

    value

    "Rotate270Degress"

  • Optional Style?: undefined | { BackgroundColor?: undefined | string; Border?: BorderStyle; BottomBorder?: BorderStyle; Color?: undefined | string; FontFamily?: undefined | string; FontSize?: undefined | string; FontStyle?: undefined | string; FontWeight?: undefined | string; Format?: undefined | string; LeftBorder?: BorderStyle; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string; RightBorder?: BorderStyle; TextAlign?: undefined | string; TextDecoration?: undefined | string; TopBorder?: BorderStyle }

    Represents style information for a Barcode

  • Optional Symbology?: "None" | "Ansi39" | "Ansi39x" | "BC412" | "Codabar" | "Code_11" | "Code_128_A" | "Code_128_B" | "Code_128_C" | "Code_128auto" | "Code_2_of_5" | "Code_93" | "Code25intlv" | "Code39" | "Code39x" | "Code49" | "Code93x" | "DataMatrix" | "EAN_13" | "EAN_8" | "EAN128FNC1" | "GS1QRCode" | "HIBCCode128" | "HIBCCode39" | "IATA_2_of_5" | "IntelligentMail" | "IntelligentMailPackage" | "ISBN" | "ISMN" | "ISSN" | "ITF14" | "JapanesePostal" | "Matrix_2_of_5" | "MaxiCode" | "MicroPDF417" | "MicroQRCode" | "MSI" | "Pdf417" | "Pharmacode" | "Plessey" | "PostNet" | "PZN" | "QRCode" | "RM4SCC" | "RSS14" | "RSS14Stacked" | "RSS14StackedOmnidirectional" | "RSS14Truncated" | "RSSExpanded" | "RSSExpandedStacked" | "RSSLimited" | "SSCC_18" | "Telepen" | "UCCEAN128" | "UPC_A" | "UPC_E0" | "UPC_E1"

    Gets or sets a value indicating the Barcode type. Supported values are

    value

    "Ansi39"

    value

    "Ansi39x"

    value

    "Codabar"

    value

    "Code_128_A"

    value

    "Code_128_B"

    value

    "Code_128_C"

    value

    "Code_128auto"

    value

    "Code_93"

    value

    "Code25intlv"

    value

    "Code_93"

    value

    "Code39"

    value

    "Code39x"

    value

    "Code49"

    value

    "Code93x"

    value

    "DataMatrix"

    value

    "EAN_13"

    value

    "EAN_8"

    value

    "GS1QRCode"

    value

    "ITF14"

    value

    "JapanesePostal"

    value

    "Pdf417"

    value

    "QRCode"

    value

    "RSS14"

    value

    "RSS14Stacked"

    value

    "RSS14StackedOmnidirectional"

    value

    "RSS14Truncated"

    value

    "RSSLimited"

    value

    "UCCEAN128"

    value

    "UPC_A"

    value

    "UPC_E0"

    value

    "UPC_E1"

  • Optional ToolTip?: undefined | string

    Gets or sets a value or an expression indicating the text displayed when a report reader hovers over a Barcode at preview time

  • Optional Top?: undefined | string

    Gets or sets a value in Length units indicating the distance of a Barcode from the top of the barcode's container

  • Type: "barcode"

    Should be set to "barcode"

  • Optional Value?: undefined | string

    Gets or sets a value or an expression that is displayed for a Barcode

  • Optional Visibility?: Visibility

    Gets or sets a value indicating whether a Barcode is hidden

    see

    Visibility

  • Optional Width?: undefined | string

    Gets or sets a value in Length units indicating the width of a Barcode

  • Optional ZIndex?: undefined | number

    Gets or sets a value indicating the stack order of a Barcode

BarcodeCode49Options

BarcodeCode49Options: { GroupNumber?: undefined | number; Grouping?: undefined | false | true }

Represents options of a Code49 Barcode

see

Barcode

Type declaration

  • Optional GroupNumber?: undefined | number

    Gets or sets a value between 0 and 8 indicating for the Code49 barcode grouping.

  • Optional Grouping?: undefined | false | true

    Gets or sets a value indicating whether to use grouping for the Code49 barcode.

BarcodeDataMatrixOptions

BarcodeDataMatrixOptions: { Ecc000_140SymbolSize?: "Auto" | "Square9" | "Square11" | "Square13" | "Square15" | "Square17" | "Square19" | "Square21" | "Square23" | "Square25" | "Square27" | "Square29" | "Square31" | "Square33" | "Square35" | "Square37" | "Square39" | "Square41" | "Square43" | "Square45" | "Square47" | "Square49"; Ecc200EncodingMode?: "Auto" | "Text" | "ASCII" | "C40" | "X12" | "EDIFACT" | "Base256"; Ecc200SymbolSize?: "SquareAuto" | "RectangularAuto" | "Square10" | "Square12" | "Square14" | "Square16" | "Square18" | "Square20" | "Square22" | "Square24" | "Square26" | "Square32" | "Square36" | "Square40" | "Square44" | "Square48" | "Square52" | "Square64" | "Square72" | "Square80" | "Square88" | "Square96" | "Square104" | "Square120" | "Square132" | "Square144" | "Rectangular8x18" | "Rectangular8x32" | "Rectangular12x26" | "Rectangular12x36" | "Rectangular16x36" | "Rectangular16x48"; EccMode?: "ECC200" | "ECC000" | "ECC050" | "ECC080" | "ECC100" | "ECC140"; Encoding?: undefined | string; FileIdentifier?: undefined | number; StructureNumber?: undefined | number; StructuredAppend?: undefined | false | true }

Represents options of a DataMatrix Barcode

see

Barcode

Type declaration

  • Optional Ecc000_140SymbolSize?: "Auto" | "Square9" | "Square11" | "Square13" | "Square15" | "Square17" | "Square19" | "Square21" | "Square23" | "Square25" | "Square27" | "Square29" | "Square31" | "Square33" | "Square35" | "Square37" | "Square39" | "Square41" | "Square43" | "Square45" | "Square47" | "Square49"
  • Optional Ecc200EncodingMode?: "Auto" | "Text" | "ASCII" | "C40" | "X12" | "EDIFACT" | "Base256"
  • Optional Ecc200SymbolSize?: "SquareAuto" | "RectangularAuto" | "Square10" | "Square12" | "Square14" | "Square16" | "Square18" | "Square20" | "Square22" | "Square24" | "Square26" | "Square32" | "Square36" | "Square40" | "Square44" | "Square48" | "Square52" | "Square64" | "Square72" | "Square80" | "Square88" | "Square96" | "Square104" | "Square120" | "Square132" | "Square144" | "Rectangular8x18" | "Rectangular8x32" | "Rectangular12x26" | "Rectangular12x36" | "Rectangular16x36" | "Rectangular16x48"
  • Optional EccMode?: "ECC200" | "ECC000" | "ECC050" | "ECC080" | "ECC100" | "ECC140"
  • Optional Encoding?: undefined | string
  • Optional FileIdentifier?: undefined | number
  • Optional StructureNumber?: undefined | number
  • Optional StructuredAppend?: undefined | false | true

BarcodePdf417Options

BarcodePdf417Options: { Columns?: undefined | number; ErrorCorrectionLevel?: "Level0" | "Level1" | "Level2" | "Level3" | "Level4" | "Level5" | "Level6" | "Level7" | "Level8"; Pdf417Type?: "Normal" | "Simple"; Rows?: undefined | number }

Represents options for a Pdf417 Barcode.

see

Barcode

Type declaration

  • Optional Columns?: undefined | number
  • Optional ErrorCorrectionLevel?: "Level0" | "Level1" | "Level2" | "Level3" | "Level4" | "Level5" | "Level6" | "Level7" | "Level8"
  • Optional Pdf417Type?: "Normal" | "Simple"
  • Optional Rows?: undefined | number

BarcodeQrCodeOptions

BarcodeQrCodeOptions: { Connection?: undefined | false | true; ConnectionNumber?: undefined | number; Encoding?: undefined | string; ErrorLevel?: "L" | "M" | "Q" | "H"; Mask?: "Auto" | "Mask000" | "Mask001" | "Mask010" | "Mask011" | "Mask100" | "Mask101" | "Mask110" | "Mask111"; Model?: "Model2" | "Model1"; Version?: undefined | number }

Represents options for a QRCodeBarcode.

see

Barcode

Type declaration

  • Optional Connection?: undefined | false | true
  • Optional ConnectionNumber?: undefined | number
  • Optional Encoding?: undefined | string
  • Optional ErrorLevel?: "L" | "M" | "Q" | "H"
  • Optional Mask?: "Auto" | "Mask000" | "Mask001" | "Mask010" | "Mask011" | "Mask100" | "Mask101" | "Mask110" | "Mask111"
  • Optional Model?: "Model2" | "Model1"
  • Optional Version?: undefined | number

Body

Body: { Height?: undefined | string; Name?: undefined | string; ReportItems?: ReportItem[]; Style?: undefined | { BackgroundColor?: undefined | string; BackgroundImage?: BackgroundImage; Border?: BorderStyle; BottomBorder?: BorderStyle; LeftBorder?: BorderStyle; RightBorder?: BorderStyle; TopBorder?: BorderStyle } }

Represents the structure and layout information for the body of a report

Type declaration

  • Optional Height?: undefined | string

    Gets or sets the height of the body of a report in Length units

  • Optional Name?: undefined | string

    Get or sets a unique identifier for the body of a report

  • Optional ReportItems?: ReportItem[]

    Gets or sets the collection of report items contained in the body of a report

    see

    ReportItem

  • Optional Style?: undefined | { BackgroundColor?: undefined | string; BackgroundImage?: BackgroundImage; Border?: BorderStyle; BottomBorder?: BorderStyle; LeftBorder?: BorderStyle; RightBorder?: BorderStyle; TopBorder?: BorderStyle }

    Represents appearance information for the body of a report

BorderStyle

BorderStyle: { Color?: undefined | string; Style?: undefined | string; Width?: undefined | string }

Represents appearance properties for a border for a report item

Type declaration

  • Optional Color?: undefined | string

    Gets or sets expression that evaluates to the color of a border

    value

    should be either a cross-browser color name or to a hexadecimal color code, such as #face0d.

  • Optional Style?: undefined | string

    Gets or sets expression that evaluates to the style of a border

    value

    "None" indicates that no border is drawn.

    value

    "Dotted" indicates a dotted line for a border.

    value

    "Dashed" indicates a dashed line for a border.

    value

    "Solid" indicates a solid line for a border.

    value

    "Double" indicates a double solid line for a border.

    value

    "Groove" indicates a 3D grooved border. The effect depends on the border color value.

    value

    "Ridge" indicates a 3D ridged border. The effect depends on the border color value.

    value

    "Inset" indicates a 3D inset border. The effect depends on the border color value.

    value

    "Outset" indicates a 3D outset border. The effect depends on the border color value.

  • Optional Width?: undefined | string

    Gets or sets expression that evaluates to the width of a border

    value

    should be in Length units

Bullet

Bullet: { BestValue?: undefined | string; Bookmark?: undefined | string; Height?: undefined | string; Interval?: undefined | string; Label?: undefined | string; LabelFontColor?: undefined | string; LabelFontFamily?: undefined | string; LabelFontSize?: undefined | string; LabelFontStyle?: undefined | string; LabelFormat?: undefined | string; Left?: undefined | string; Name: string; Orientation?: "Horizontal" | "Vertical"; Range1Boundary?: undefined | string; Range2Boundary?: undefined | string; ShowLabels?: undefined | false | true; TargetLineColor?: undefined | string; TargetLineWidth?: undefined | string; TargetShape?: "Line" | "Dot" | "Square"; TargetValue?: undefined | string; TickMarks?: "None" | "Inside" | "Outside"; TicksLineColor?: undefined | string; TicksLineWidth?: undefined | string; ToolTip?: undefined | string; Top?: undefined | string; Type: "bullet"; Value?: undefined | string; ValueColor?: undefined | string; Visibility?: Visibility; Width?: undefined | string; WorstValue?: undefined | string; ZIndex?: undefined | number }

Represents properties for a Bullet chart in a report

Type declaration

  • Optional BestValue?: undefined | string

    Gets or sets a value or an expression indicating the upper value of a Bullet chart.

  • Optional Bookmark?: undefined | string

    Gets or sets a value or an expression indicating the Id of a Bullet chart for a Jump To Bookmark interactivity action.

  • Optional Height?: undefined | string

    Gets or sets a value in Length units indicating the height of a Bullet chart.

  • Optional Interval?: undefined | string

    Gets or sets a value or an expression indicating the interval between tick marks of a Bullet chart.

  • Optional Label?: undefined | string

    Gets or sets a value or an expression indicating the text associated with a Bullet chart that appears in the Report Map and Table of Contents

  • Optional LabelFontColor?: undefined | string

    Gets or sets a value or an expression indicating the foreground color of Bullet chart labels. The value or the expression result should be a cross-browser color name or to a hexadecimal color code, such as #face0d.

  • Optional LabelFontFamily?: undefined | string

    Gets or sets a value or an expression indicating the name of the font family for Bullet chart labels.

  • Optional LabelFontSize?: undefined | string

    Gets or sets a value or an expression indicating the font size for Bullet chart labels. The value or the expression result should be in Length units.

  • Optional LabelFontStyle?: undefined | string

    Gets or sets a value or an expression indicating the font style for Bullet chart labels. The value or the expression result should be one of the following.

    value

    "Normal" indicates that the font is not italicized.

    value

    "Italic" indicates that that the font is italicized.

  • Optional LabelFormat?: undefined | string

    Gets or sets a value or an expression indicating a formatting code that is used when the numeric value in a Bullet chart label is formatted. Supported formats are

  • Optional Left?: undefined | string

    Gets or sets a value in Length units indicating the distance of a Bullet chart from the left of the charts's container

  • Name: string

    Gets or sets a unique identifier for a Bullet chart

  • Optional Orientation?: "Horizontal" | "Vertical"

    Gets or sets a value indicating the orientation of a Bullet chart.

  • Optional Range1Boundary?: undefined | string

    Gets or sets a value or an expression indicating the first range of values in a Bullet chart.

  • Optional Range2Boundary?: undefined | string

    Gets or sets a value or an expression indicating the second range of values in a Bullet chart.

  • Optional ShowLabels?: undefined | false | true

    Gets or sets a value indicating whether labels of Bullet chart are displayed.

  • Optional TargetLineColor?: undefined | string

    Gets or sets a value or an expression indicating the foreground of the target value's graphical representation. The value or the expression result should be a cross-browser color name or to a hexadecimal color code, such as #face0d.

  • Optional TargetLineWidth?: undefined | string

    Gets or sets a value or an expression indicating the border thickness of the target value's graphical representation. The value or the expression result should be in Length units.

  • Optional TargetShape?: "Line" | "Dot" | "Square"

    Gets or sets a value indicating the shape of the target value graphical representation.

  • Optional TargetValue?: undefined | string

    Gets or sets a value or an expression indicating the target value of a Bullet chart.

  • Optional TickMarks?: "None" | "Inside" | "Outside"

    Gets or sets a value indicating the position of tick marks relative to an axis of a Bullet chart.

  • Optional TicksLineColor?: undefined | string

    Gets or sets a value or an expression indicating the foreground of tick marks of a Bullet chart. The value or the expression result should be a cross-browser color name or to a hexadecimal color code, such as #face0d.

  • Optional TicksLineWidth?: undefined | string

    Gets or sets a value or an expression indicating the border thickness of tick marks of a Bullet chart. The value or the expression result should be in Length units.

  • Optional ToolTip?: undefined | string

    Gets or sets a value or an expression indicating the text displayed when a report reader hovers over a Bullet chart at preview time

  • Optional Top?: undefined | string

    Gets or sets a value in Length units indicating the distance of a Bullet chart from the top of the charts's container

  • Type: "bullet"

    Should be set to "bullet"

  • Optional Value?: undefined | string
  • Optional ValueColor?: undefined | string

    Gets or sets a value or an expression indicating the foreground of the actual value's graphical representation. The value or the expression result should be a cross-browser color name or to a hexadecimal color code, such as #face0d.

  • Optional Visibility?: Visibility

    Gets or sets a value indicating whether a Bullet chart is hidden

    see

    Visibility

  • Optional Width?: undefined | string

    Gets or sets a value in Length units indicating the width of a Bullet chart.

  • Optional WorstValue?: undefined | string

    Gets or sets a value or an expression indicating the lower value of a Bullet chart.

  • Optional ZIndex?: undefined | number

    Gets or sets a value indicating the stack order of a Bullet chart

Checkbox

Checkbox: { Bookmark?: undefined | string; CheckAlignment?: "MiddleLeft" | "TopLeft" | "TopCenter" | "TopRight" | "MiddleCenter" | "MiddleRight" | "BottomLeft" | "BottomCenter" | "BottomRight"; Checked?: undefined | string; Height?: undefined | string; Label?: undefined | string; Left?: undefined | string; Name: string; Style?: undefined | { BackgroundColor?: undefined | string; BackgroundImage?: BackgroundImage; Border?: BorderStyle; BottomBorder?: BorderStyle; Color?: undefined | string; FontFamily?: undefined | string; FontSize?: undefined | string; FontStyle?: undefined | string; FontWeight?: undefined | string; LeftBorder?: BorderStyle; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string; RightBorder?: BorderStyle; TextDecoration?: undefined | string; TopBorder?: BorderStyle; WrapMode?: undefined | string }; Text?: undefined | string; ToolTip?: undefined | string; Top?: undefined | string; Type: "checkbox"; Visibility?: Visibility; Width?: undefined | string; ZIndex?: undefined | number }

Represents properties for a Checkbox in a report

Type declaration

  • Optional Bookmark?: undefined | string

    Gets or sets a value or an expression indicating the Id of a checkbox for a Jump To Bookmark interactivity action.

  • Optional CheckAlignment?: "MiddleLeft" | "TopLeft" | "TopCenter" | "TopRight" | "MiddleCenter" | "MiddleRight" | "BottomLeft" | "BottomCenter" | "BottomRight"

    Gets or sets a value indicating the checked or unchecked box position relative to the report item bounds.

  • Optional Checked?: undefined | string

    Gets or sets a value or an expression indicating whether the box displayed along with the text is checked or unchecked

  • Optional Height?: undefined | string

    Gets or sets a value in Length units indicating the height of a Checkbox

  • Optional Label?: undefined | string

    Gets or sets a value or an expression indicating the text associated with a checkbox that appears in the Report Map and Table of Contents

  • Optional Left?: undefined | string

    Gets or sets a value in Length units indicating the distance of a Checkbox from the left of the checkbox's container

  • Name: string

    Gets or sets a unique identifier for a Checkbox

  • Optional Style?: undefined | { BackgroundColor?: undefined | string; BackgroundImage?: BackgroundImage; Border?: BorderStyle; BottomBorder?: BorderStyle; Color?: undefined | string; FontFamily?: undefined | string; FontSize?: undefined | string; FontStyle?: undefined | string; FontWeight?: undefined | string; LeftBorder?: BorderStyle; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string; RightBorder?: BorderStyle; TextDecoration?: undefined | string; TopBorder?: BorderStyle; WrapMode?: undefined | string }

    Represents style information for a Checkbox

  • Optional Text?: undefined | string

    Gets or sets a value or an expression indicating the textual the content to be displayed in the checkbox.

  • Optional ToolTip?: undefined | string

    Gets or sets a value or an expression indicating the text displayed when a report reader hovers over a checkbox at preview time

  • Optional Top?: undefined | string

    Gets or sets a value in Length units indicating the distance of a Checkbox from the top of the checkbox's container

  • Type: "checkbox"

    Should be set to "checkbox"

  • Optional Visibility?: Visibility

    Gets or sets a value indicating whether a Checkbox is hidden

    see

    Visibility

  • Optional Width?: undefined | string

    Gets or sets a value in Length units indicating the width of a Checkbox

  • Optional ZIndex?: undefined | number

    Gets or sets a value indicating the stack order of a checkbox

ConnectionProperties

ConnectionProperties: { ConnectString?: undefined | string }

Represents information about how to connect to a data source

see

{@link DataSource.ConnectionProperties}

Type declaration

  • Optional ConnectString?: undefined | string

    Gets or sets the information necessary to connect to a data source

DataSet

DataSet: { Fields?: Field[]; Filters?: Filter[]; Name: string; Query?: Query }

Represents information about a set of data to be used as a part of a report

Type declaration

  • Optional Fields?: Field[]

    Gets or sets a set of fields to include in a DataSet

    see

    Field

  • Optional Filters?: Filter[]

    Gets or sets a set of filters to apply to each row in a DataSet

    see

    {@link @Filter}

  • Name: string

    Gets or sets a unique identifier for a DataSet

  • Optional Query?: Query

    Gets or sets the query information that is necessary to retrieve data from a data source

    see

    Query

DataSetReference

DataSetReference: { DataSetName: string; LabelField?: undefined | string; ValueField: string }

Represent the DataSet to use to obtain a list of values and, optionally, labels for the valid values or the default value of a report parameter

see

{@link ReportParameter.DefaultValue}

see

{@link ReportParameter.DefaultValue}

Type declaration

  • DataSetName: string

    Gets or sets the name of the DataSet that is being referenced

  • Optional LabelField?: undefined | string

    Gets or sets the name of the field in the referenced DataSet from which values are retrieved to populate the labels of a parameter’s valid values

  • ValueField: string

    Gets or sets the name of the field in the referenced DataSet from which values are retrieved to populate the values of a parameter’s valid values or default value

DataSource

DataSource: { ConnectionProperties?: ConnectionProperties; Name?: undefined | string }

Represents information about a data source

Type declaration

  • Optional ConnectionProperties?: ConnectionProperties

    Gets or sets information about how to connect to a data source

    see

    ConnectionProperties

  • Optional Name?: undefined | string

    Gets or sets a unique identifier for a data source

DefaultValue

DefaultValue: { DataSetReference?: DataSetReference; Values?: string[] }

Reprsents the default values for a report parameter

see

{@link ReportParameter.DefaultValue}

Type declaration

  • Optional DataSetReference?: DataSetReference

    Gets or sets the DataSet reference to use to obtain the default value or values for a report parameter

    see

    DataSetReference

  • Optional Values?: string[]

    Gets or sets the default values to use for a report parameter

DocumentMap

DocumentMap: { Levels?: ("None" | "Decimal" | "DecimalLeadingZero" | "CircledNumber" | "LowerRoman" | "UpperRoman" | "LowerLatin" | "UpperLatin" | "LowerGreek" | "UpperGreek" | "Katakana" | "KatakanaBrackets" | "KatakanaIrohaBrackets" | "KatakanaIroha" | "KatakanaLower" | "KatakanaIrohaLower" | "LowerArmenian" | "UpperArmenian" | "Georgian")[]; NumberingStyle?: "None" | "Decimal" | "DecimalLeadingZero" | "CircledNumber" | "LowerRoman" | "UpperRoman" | "LowerLatin" | "UpperLatin" | "LowerGreek" | "UpperGreek" | "Katakana" | "KatakanaBrackets" | "KatakanaIrohaBrackets" | "KatakanaIroha" | "KatakanaLower" | "KatakanaIrohaLower" | "LowerArmenian" | "UpperArmenian" | "Georgian"; Source?: "None" | "Labels" | "Headings" | "All" }

Represents the structure and layout information for a report map

Type declaration

  • Optional Levels?: ("None" | "Decimal" | "DecimalLeadingZero" | "CircledNumber" | "LowerRoman" | "UpperRoman" | "LowerLatin" | "UpperLatin" | "LowerGreek" | "UpperGreek" | "Katakana" | "KatakanaBrackets" | "KatakanaIrohaBrackets" | "KatakanaIroha" | "KatakanaLower" | "KatakanaIrohaLower" | "LowerArmenian" | "UpperArmenian" | "Georgian")[]

    Indicates the marker of items for individual hierarchy levels in the report map

  • Optional NumberingStyle?: "None" | "Decimal" | "DecimalLeadingZero" | "CircledNumber" | "LowerRoman" | "UpperRoman" | "LowerLatin" | "UpperLatin" | "LowerGreek" | "UpperGreek" | "Katakana" | "KatakanaBrackets" | "KatakanaIrohaBrackets" | "KatakanaIroha" | "KatakanaLower" | "KatakanaIrohaLower" | "LowerArmenian" | "UpperArmenian" | "Georgian"

    Gets or sets a value indicating the marker of an item in the report map

  • Optional Source?: "None" | "Labels" | "Headings" | "All"

    Gets or sets a value indicating which items are included in the report map

DvChart

DvChart: { Bar?: undefined | { BottomWidth?: undefined | number; NeckHeight?: undefined | number; Overlap?: undefined | number; TopWidth?: undefined | number; Width?: undefined | number }; Bookmark?: undefined | string; CustomPalette?: string[]; DataSetName?: undefined | string; Filters?: Filter[]; Footer?: DvChartHeaderFooter; Header?: DvChartHeaderFooter; Height?: undefined | string; Label?: undefined | string; Left?: undefined | string; Legend?: DvChartGlobalLegend; Name: string; NoRowsMessage?: undefined | string; PageBreak?: "None" | "Start" | "End" | "StartAndEnd" | "Between"; Palette?: DvChartPalette; PlotArea?: DvChartPlotArea; Plots?: DvChartPlot[]; Style?: undefined | { BackgroundColor?: undefined | string; BackgroundGradientEndColor?: undefined | string; BackgroundGradientType?: undefined | string; BackgroundImage?: BackgroundImage; Border?: BorderStyle; BottomBorder?: BorderStyle; Color?: undefined | string; Direction?: undefined | string; FontFamily?: undefined | string; FontSize?: undefined | string; FontStyle?: undefined | string; FontWeight?: undefined | string; Format?: undefined | string; Language?: undefined | string; LeftBorder?: BorderStyle; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string; RightBorder?: BorderStyle; TextAlign?: undefined | string; TextDecoration?: undefined | string; TopBorder?: BorderStyle; VerticalAlign?: undefined | string; WritingMode?: undefined | string }; ToolTip?: undefined | string; Top?: undefined | string; Type: "dvchart"; Visibility?: Visibility; Width?: undefined | string; ZIndex?: undefined | number }

Represents properties for a Chart in a report

Type declaration

  • Optional Bar?: undefined | { BottomWidth?: undefined | number; NeckHeight?: undefined | number; Overlap?: undefined | number; TopWidth?: undefined | number; Width?: undefined | number }

    Represents the dimensions and form of columns and bars for Bar and Column charts.

  • Optional Bookmark?: undefined | string

    Gets or sets a value or an expression indicating the Id of a Chart for a Jump To Bookmark interactivity action.

  • Optional CustomPalette?: string[]

    Gets or sets a value indicating the colors for a custom color palette. The array items should be a cross-browser color name or to a hexadecimal color code, such as #face0d.

  • Optional DataSetName?: undefined | string

    Gets or sets the name of the dataset to use to bind data to a Chart.

  • Optional Filters?: Filter[]

    Gets or sets a value indicating a collection of filters to be applied to the data for each row of a Chart

    see

    Filter

  • Optional Footer?: DvChartHeaderFooter

    Gets or sets a value indicating the properties for the footer of a Chart.

    see

    DvChartHeaderFooter

  • Optional Header?: DvChartHeaderFooter

    Gets or sets a value indicating the properties for the header of a Chart.

    see

    DvChartHeaderFooter

  • Optional Height?: undefined | string

    Gets or sets a value in Length units indicating the height of a Chart

  • Optional Label?: undefined | string

    Gets or sets a value or an expression indicating the text associated with a Chart that appears in the Report Map and Table of Contents

  • Optional Left?: undefined | string

    Gets or sets a value in Length units indicating the distance of a Chart from the left of the charts's container

  • Optional Legend?: DvChartGlobalLegend

    Gets or sets a value indicating the properties for the global legend of a Chart.

    see

    DvChartGlobalLegend

  • Name: string

    Gets or sets a unique identifier for a Chart

  • Optional NoRowsMessage?: undefined | string

    Gets or sets a value or an expression indicating text to render instead of the list layout when no rows of data are available for a Chart.

  • Optional PageBreak?: "None" | "Start" | "End" | "StartAndEnd" | "Between"

    Gets or sets a value indicating the location of a page breaks generated by a Chart

  • Optional Palette?: DvChartPalette

    Gets or sets a value indicating the color palette of a Chart.

    see

    DvChartGlobalLegend

  • Optional PlotArea?: DvChartPlotArea

    Gets or sets a value indicating the properties for the plot area of a Chart.

    see

    DvChartPlotArea

  • Optional Plots?: DvChartPlot[]

    Gets or sets a value indicating a collection of chart plots.

    see

    DvChartPlot

  • Optional Style?: undefined | { BackgroundColor?: undefined | string; BackgroundGradientEndColor?: undefined | string; BackgroundGradientType?: undefined | string; BackgroundImage?: BackgroundImage; Border?: BorderStyle; BottomBorder?: BorderStyle; Color?: undefined | string; Direction?: undefined | string; FontFamily?: undefined | string; FontSize?: undefined | string; FontStyle?: undefined | string; FontWeight?: undefined | string; Format?: undefined | string; Language?: undefined | string; LeftBorder?: BorderStyle; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string; RightBorder?: BorderStyle; TextAlign?: undefined | string; TextDecoration?: undefined | string; TopBorder?: BorderStyle; VerticalAlign?: undefined | string; WritingMode?: undefined | string }

    Represents style information for a Chart

  • Optional ToolTip?: undefined | string

    Gets or sets a value or an expression indicating the text displayed when a report reader hovers over a Chart at preview time

  • Optional Top?: undefined | string

    Gets or sets a value in Length units indicating the distance of a Chart from the top of the charts's container

  • Type: "dvchart"

    Should be set to "dvchart"

  • Optional Visibility?: Visibility

    Gets or sets a value indicating whether a Chart is hidden

    see

    Visibility

  • Optional Width?: undefined | string

    Gets or sets a value in Length units indicating the width of a Chart

  • Optional ZIndex?: undefined | number

    Gets or sets a value indicating the stack order of a Chart

DvChartAggregate

DvChartAggregate: "None" | "Average" | "Count" | "CountOfAll" | "List" | "Max" | "Min" | "PopulationStandardDeviation" | "PopulationVariance" | "Range" | "StandardDeviation" | "Sum" | "Variance"

Represents the function that reduces many values into a single value.

DvChartAggregateEncoding

DvChartAggregateEncoding: { Aggregate?: DvChartAggregate; Field?: undefined | { Value?: string[] } }

Represents the properties for an encoding of a plot of a chart.

see

DvChartEncodings

Type declaration

  • Optional Aggregate?: DvChartAggregate

    Gets or sets a value indicating the aggregate function that applies to the encoding values.

    see

    DvChartAggregate

  • Optional Field?: undefined | { Value?: string[] }

    Represents an encoding value

DvChartAxis

DvChartAxis: { AxisLine?: undefined | false | true; AxisType?: "X" | "Y"; Format?: undefined | string; LabelAngle?: undefined | number; LabelStyle?: DvChartTextStyleWithPadding; Labels?: undefined | false | true; LineStyle?: undefined | { Border?: BorderStyle }; LogBase?: undefined | number; MajorGrid?: undefined | false | true; MajorGridStyle?: undefined | { Border?: BorderStyle }; MajorTickSize?: undefined | string; MajorTickStyle?: undefined | { Border?: BorderStyle }; MajorTicks?: "None" | "Inside" | "Outside" | "Cross"; MajorUnit?: undefined | string; Max?: undefined | string; Min?: undefined | string; MinorGrid?: undefined | false | true; MinorGridStyle?: undefined | { Border?: BorderStyle }; MinorTickSize?: undefined | string; MinorTickStyle?: undefined | { Border?: BorderStyle }; MinorTicks?: "None" | "Inside" | "Outside" | "Cross"; MinorUnit?: undefined | string; Origin?: undefined | string; OverlappingLabels?: "Auto" | "Show"; Plots?: string[]; Position?: "None" | "Near" | "Far"; Reversed?: undefined | false | true; Scale?: "Linear" | "Logarithmic" | "Ordinal" | "Percentage"; Title?: undefined | string; TitleStyle?: DvChartTextStyleWithPadding }

Represents properties of an axis of a chart.

Type declaration

  • Optional AxisLine?: undefined | false | true

    Gets or sets a value indicating whether the axis line is displayed.

  • Optional AxisType?: "X" | "Y"

    Gets or sets a value indicating the type of axis

    value

    "X" indicates an axis that handles categorical values

    value

    "Y" indicates an axis that handles data values

  • Optional Format?: undefined | string

    Gets or sets a value or an expression indicating a formatting code that is used when the numeric value in a NoRowsMessage is formatted. Supported formats are

  • Optional LabelAngle?: undefined | number

    Gets or sets a value from -90 to 90 indicating the labels' rotation in degrees relative to the axis line.

  • Optional LabelStyle?: DvChartTextStyleWithPadding

    Gets or sets a value indicating visual appearance of labels

    see

    DvChartTextStyleWithPadding

  • Optional Labels?: undefined | false | true

    Gets or sets a value indicating whether axis labels are displayed.

  • Optional LineStyle?: undefined | { Border?: BorderStyle }

    Represents style information for an axis line

  • Optional LogBase?: undefined | number

    Gets or sets a value indicating logarithm base for an axis with Logarithmic scale.

  • Optional MajorGrid?: undefined | false | true

    Gets or sets a value indicating whether the major grid lines are displayed.

  • Optional MajorGridStyle?: undefined | { Border?: BorderStyle }

    Represents style information for the major grid lines of an axis.

  • Optional MajorTickSize?: undefined | string

    Gets or sets a value or an expression indicating the size of the major ticks. The value or the expression result should be in Length units.

  • Optional MajorTickStyle?: undefined | { Border?: BorderStyle }

    Represents style information for the major ticks of an axis.

  • Optional MajorTicks?: "None" | "Inside" | "Outside" | "Cross"

    Gets or sets a value indicating the position of major ticks relative to the axis line.

  • Optional MajorUnit?: undefined | string

    Gets or sets a value or an expression indicating the interval between major grid lines. The value or the expression result should be a number.

  • Optional Max?: undefined | string

    Gets or sets a value or an expression indicating the lower bound of the range of values that an axis can handle.

  • Optional Min?: undefined | string

    Gets or sets a value or an expression indicating the upper bound of the range of values that an axis can handle.

  • Optional MinorGrid?: undefined | false | true

    Gets or sets a value indicating whether the minor grid lines are displayed.

  • Optional MinorGridStyle?: undefined | { Border?: BorderStyle }

    Represents style information for the minor grid lines of an axis.

  • Optional MinorTickSize?: undefined | string

    Gets or sets a value or an expression indicating the size of the minor ticks. The value or the expression result should be in Length units.

  • Optional MinorTickStyle?: undefined | { Border?: BorderStyle }

    Represents style information for the minor ticks of an axis.

  • Optional MinorTicks?: "None" | "Inside" | "Outside" | "Cross"

    Gets or sets a value indicating the position of minor ticks relative to the axis line.

  • Optional MinorUnit?: undefined | string

    Gets or sets a value or an expression indicating the interval between minor grid lines. The value or the expression result should be a number.

  • Optional Origin?: undefined | string

    Gets or sets a value of an expression indicating an axis's location relative to the orthogonal axis.

  • Optional OverlappingLabels?: "Auto" | "Show"

    Gets or sets a value indicating the appearance of overlapping axis labels.

    value

    "Auto" hides some labels to prevent the overlapping

    value

    "Show" shows all labels even if the overlapping persists

  • Optional Plots?: string[]

    Gets or sets a value indicating a collection of plots for which an axis provides the coordinate system

    see

    DvChartPlot

  • Optional Position?: "None" | "Near" | "Far"

    Gets or sets a value indicating the position of an axis relative to the containing plot area.

  • Optional Reversed?: undefined | false | true

    Gets or sets a value indicating whether the default direction of a vertical axis should be set to Top-to-Bottom, and the default direction of a horizontal axis should be set to Right-To-Left.

  • Optional Scale?: "Linear" | "Logarithmic" | "Ordinal" | "Percentage"

    Gets or sets a value indicating the axis type.

    value

    "Linear" scale evenly distributes the range of available values along the axis.

    value

    "Logarithmic" scale uses the logarithm of values instead of the values themselves.

    value

    "Ordinal" applies to non-numerical values which evenly distribute along the axis as per their order.

    value

    "Percentage" scale used for Percentage Stacked plots.

  • Optional Title?: undefined | string

    Gets or sets a value of an expression indicating the title of an axis.

  • Optional TitleStyle?: DvChartTextStyleWithPadding

    Gets or sets a value indicating visual appearance of the title of an axis.

    see

    DvChartTextStyleWithPadding

DvChartCategoryEncoding

DvChartCategoryEncoding: { Field?: undefined | { Value?: string[] }; Sort?: "None" | "Ascending" | "Descending"; SortingAggregate?: DvChartAggregate; SortingField?: undefined | string }

Represents properties of the categories for a plot of a chart.

Type declaration

  • Optional Field?: undefined | { Value?: string[] }

    Represents categories value.

  • Optional Sort?: "None" | "Ascending" | "Descending"

    Gets or sets a value indicating the sort order of categories appearance.

  • Optional SortingAggregate?: DvChartAggregate

    Gets or sets a value indicating the aggregate function that applies to the SortingField values.

    see

    DvChartAggregate

  • Optional SortingField?: undefined | string

    Gets or sets an expression indicating the order of categories appearance.

DvChartDetailEncoding

DvChartDetailEncoding: { ExcludeNulls?: undefined | false | true; Field?: undefined | { Value?: string[] }; Group?: "None" | "Cluster" | "Stack"; Sort?: "None" | "Ascending" | "Descending"; SortingAggregate?: DvChartAggregate; SortingField?: undefined | string }

Represents the properties for category details of a plot of a chart.

see

DvChartEncodings

Type declaration

  • Optional ExcludeNulls?: undefined | false | true

    Gets or sets a value indicating whether the details encoding should exclude null values.

  • Optional Field?: undefined | { Value?: string[] }

    Represents an encoding value

  • Optional Group?: "None" | "Cluster" | "Stack"

    Gets or sets a value indicating the arrangement of details within the parent category.

  • Optional Sort?: "None" | "Ascending" | "Descending"

    Gets or sets a value indicating the sort order of details appearance within the parent category.

  • Optional SortingAggregate?: DvChartAggregate

    Gets or sets a value indicating the aggregate function that applies to the SortingField values.

    see

    DvChartAggregate

  • Optional SortingField?: undefined | string

    Gets or sets an expression indicating the order of details appearance within the parent category.

DvChartEncodings

Represents the graphical representation of the data for a plot of a chart.

see

DvChartPlot

Type declaration

DvChartGlobalLegend

DvChartGlobalLegend: { Hidden?: undefined | false | true; Orientation?: "Horizontal" | "Vertical"; Position?: "Left" | "Right" | "Top" | "Bottom"; Style?: undefined | { BackgroundColor?: undefined | string; Border?: BorderStyle; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string }; TextStyle?: DvChartTextStyle; TitleStyle?: DvChartTextStyle }

Represents the properties for the global legend of a chart.

see

DvChart

Type declaration

  • Optional Hidden?: undefined | false | true

    Gets or sets a value indicating whether the global legend of a chart is hidden.

  • Optional Orientation?: "Horizontal" | "Vertical"

    Gets or sets a value indicating the arrangement of labels in the global legend of a chart.

  • Optional Position?: "Left" | "Right" | "Top" | "Bottom"

    Gets or sets a value indicating the position of the global legend of a chart relative to the sides and corners of the plot area.

  • Optional Style?: undefined | { BackgroundColor?: undefined | string; Border?: BorderStyle; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string }

    Represents style information for the global legend of a Chart.

  • Optional TextStyle?: DvChartTextStyle

    Gets or sets a value indicating the appearance of labels in the global legend of a chart.

    see

    DvChartTextStyle

  • Optional TitleStyle?: DvChartTextStyle

    Gets or sets a value indicating the appearance of the title of the global legend of a chart.

    see

    DvChartTextStyle

DvChartHeaderFooter

DvChartHeaderFooter: { HAlign?: "Center" | "Left" | "Right"; Height?: string | number; Style?: undefined | { BackgroundColor?: undefined | string; Border?: BorderStyle; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string }; TextStyle?: DvChartTextStyle; Title?: undefined | string; VAlign?: "Top" | "Middle" | "Bottom" }

Represents properties for the header or footer of a chart.

Type declaration

  • Optional HAlign?: "Center" | "Left" | "Right"

    Gets or sets a value indicating the horizontal alignment for the text within the header or footer of a chart.

  • Optional Height?: string | number

    Gets or sets a value in the percentage of the containing chart's height indicating the height of the header of footer of a chart.

  • Optional Style?: undefined | { BackgroundColor?: undefined | string; Border?: BorderStyle; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string }

    Represents style information for the header or footer of a chart.

  • Optional TextStyle?: DvChartTextStyle

    Gets or sets a value indicating the appearance of text within the header or footer of a chart.

    see

    DvChartTextStyle

  • Optional Title?: undefined | string

    Gets or sets a value of an expression indicating the text displayed in the header or footer of a chart.

  • Optional VAlign?: "Top" | "Middle" | "Bottom"

    Gets or sets a value indicating the vertical alignment for the text within the header or footer of a chart.

DvChartLegendOption

DvChartLegendOption: { Hidden?: undefined | false | true; LegendType?: "Color" | "Shape" | "Size"; MaxHeight?: undefined | number; MaxWidth?: undefined | number; Orientation?: "Horizontal" | "Vertical"; Position?: "Left" | "Right" | "Top" | "Bottom"; Style?: undefined | { BackgroundColor?: undefined | string; Border?: BorderStyle; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string }; TextStyle?: DvChartTextStyle; Title?: undefined | string; TitleStyle?: DvChartTextStyle }

Represents properties for a Color, Shape or Size Legend of a plot of a chart.

Type declaration

  • Optional Hidden?: undefined | false | true

    Gets or sets a value indicating whether a legend of a chart is hidden.

  • Optional LegendType?: "Color" | "Shape" | "Size"

    Gets or sets a value indicating the type of a legend.

  • Optional MaxHeight?: undefined | number

    Gets or sets a value in percentage relative to the plot area height indicating the maximum height of a legend.

  • Optional MaxWidth?: undefined | number

    Gets or sets a value in percentage relative to the plot area height indicating the maximum width of a legend.

  • Optional Orientation?: "Horizontal" | "Vertical"

    Gets or sets a value indicating the arrangement of labels in a legend of a chart.

  • Optional Position?: "Left" | "Right" | "Top" | "Bottom"

    Gets or sets a value indicating the position of a legend of a chart relative to the sides and corners of the plot area.

  • Optional Style?: undefined | { BackgroundColor?: undefined | string; Border?: BorderStyle; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string }

    Represents style information for a legend of a Chart.

  • Optional TextStyle?: DvChartTextStyle

    Gets or sets a value indicating the appearance of labels in a legend of a chart.

    see

    DvChartTextStyle

  • Optional Title?: undefined | string

    Gets or sets a value or an expression indicating the title of a legend.

  • Optional TitleStyle?: DvChartTextStyle

    Gets or sets a value indicating the appearance of the title of a legend of a chart.

    see

    DvChartTextStyle

DvChartPalette

DvChartPalette: "Light" | "Office" | "Aspect" | "Blue" | "Blue2" | "BlueGreen" | "BlueWarm" | "Cerulan" | "Cocoa" | "Coral" | "Cyborg" | "Dark" | "Darkly" | "Flatly" | "Grayscale" | "Green" | "GreenYellow" | "HighContrast" | "Marquee" | "Median" | "Midnight" | "Modern" | "Office2010" | "Orange" | "OrangeRed" | "Organic" | "Paper" | "Red" | "RedOrange" | "RedViolet" | "Slate" | "Slipstream" | "Standard" | "Superhero" | "Violet" | "Violet2" | "Yellow" | "YellowOrange" | "Zen" | "Custom"

Represents the color paletter of a chart.

see

DvChart

DvChartPlot

DvChartPlot: { Config?: DvChartPlotConfig; Encodings?: DvChartEncodings; PlotChartSubtype?: "Plain" | "Clustered" | "Stacked"; PlotChartType?: "Custom" | "Bar" | "Line" | "Area" | "Scatter" | "HighLowOpenClose" | "Candlestick" | "Column" | "Pie" | "Pyramid" | "Funnel" | "Bubble" | "Gantt" | "HighLowClose" | "PolarColumn" | "PolarBar" | "RadarArea" | "RadarBubble" | "RadarScatter" | "RadarLine"; PlotName?: undefined | string }

Represents properties for the plot of a chart.

see

DvChart

Type declaration

  • Optional Config?: DvChartPlotConfig

    Gets or sets a value indicating the configuration for a plot of a chart.

    see

    DvChartPlotConfig

  • Optional Encodings?: DvChartEncodings

    Gets or sets a value indicating the graphical representation of the data for a plot of a chart.

    see

    DvChartEncodings

  • Optional PlotChartSubtype?: "Plain" | "Clustered" | "Stacked"

    Gets or sets a value indicating the sub-type for a plot of a chart.

  • Optional PlotChartType?: "Custom" | "Bar" | "Line" | "Area" | "Scatter" | "HighLowOpenClose" | "Candlestick" | "Column" | "Pie" | "Pyramid" | "Funnel" | "Bubble" | "Gantt" | "HighLowClose" | "PolarColumn" | "PolarBar" | "RadarArea" | "RadarBubble" | "RadarScatter" | "RadarLine"

    Gets or sets a value indicating the type for a plot of a chart.

  • Optional PlotName?: undefined | string

    Gets or sets a unique identifier for a plot of a chart.

DvChartPlotArea

DvChartPlotArea: { Axes?: DvChartAxis[]; Legends?: DvChartLegendOption[]; Style?: undefined | { BackgroundColor?: undefined | string; Border?: BorderStyle; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string } }

Represents properties of the plot area of a chart.

see

DvChart

Type declaration

  • Optional Axes?: DvChartAxis[]

    Gets or sets a value indicating a collection of axes within the plot area of a chart.

  • Optional Legends?: DvChartLegendOption[]

    Gets or sets a value indicating a collection of legends within the plot area of a chart.

  • Optional Style?: undefined | { BackgroundColor?: undefined | string; Border?: BorderStyle; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string }

    Represents style information for the plot area of a chart.

DvChartPlotConfig

DvChartPlotConfig: { Action?: Action; AxisMode?: "Cartesian" | "Radial" | "Polygonal"; BarLines?: undefined | false | true; ClippingMode?: "None" | "Clip" | "Fit"; InnerRadius?: undefined | number; LineAspect?: "Default" | "Spline" | "StepCenter" | "StepLeft" | "StepRight"; LineStyle?: BorderStyle; Offset?: undefined | number; Opacity?: undefined | number; Radial?: undefined | false | true; Rules?: DvChartRule[]; ShowNulls?: "Gaps" | "Connected" | "Zeros"; StartAngle?: undefined | number; Style?: undefined | { BackgroundColor?: undefined | string }; Sweep?: undefined | number; SymbolOpacity?: undefined | number; SymbolShape?: "Auto" | "X" | "Dot" | "Box" | "Diamond" | "Triangle" | "Dash" | "Plus"; SymbolStyle?: undefined | { BackgroundColor?: undefined | string; Border?: BorderStyle }; Symbols?: undefined | false | true; Text?: undefined | { ConnectingLine?: undefined | { Border?: BorderStyle }; LinePosition?: "Auto" | "Center"; Offset?: undefined | number; OverlappingLabels?: "Auto" | "Show"; Style?: undefined | { BackgroundColor?: undefined | string; Border?: BorderStyle; Color?: undefined | string; FontFamily?: undefined | string; FontSize?: undefined | string; FontStyle?: undefined | string; FontWeight?: undefined | string; TextDecoration?: undefined | string }; Template?: undefined | string; TextPosition?: "Auto" | "Center" | "Inside" | "Outside" }; Tooltip?: undefined | { Template?: undefined | string } }

Represents the configuration for a plot of a chart.

Type declaration

  • Optional Action?: Action

    Gets or sets an action (such as a hyperlink) associated with a plot of a chart.

    see

    Action

  • Optional AxisMode?: "Cartesian" | "Radial" | "Polygonal"

    Gets or sets a value indicating the type of axes for a plot of a chart.

    value

    "Radial" is applicable for "Pie", "PolarColumn", "PolarBar" plots.

    value

    "Cartesian" is applicable for "Bar", "Line", "Area", "Scatter", "HighLowOpenClose", "Candlestick","Column", "Pyramid", "Funnel", "Bubble", "Gantt", "HighLowClose" plots.

    value

    "Polygonal" is applicable for "RadarArea", "RadarBubble", "RadarScatter", "RadarLine" plots.

  • Optional BarLines?: undefined | false | true

    Gets or sets a value indicating whether to display the connecting lines between plot parts that belong to the same category or details.

  • Optional ClippingMode?: "None" | "Clip" | "Fit"

    Gets or sets a value indicating the manner that the plot area draws a plot that does not fit.

    value

    "None" equals to "Fit"

    value

    "Clip" indicates that the plot area cuts off a plot on the edge of its right or bottom padding

    value

    "Fit" indicates that the plot area should use all the available space to fit a plot

  • Optional InnerRadius?: undefined | number

    Gets or sets a value in percentage of the outer radius indicating the size of a hole in the center of the disk for "Pie", "PolarColumn", and "PolarBar" plots.

  • Optional LineAspect?: "Default" | "Spline" | "StepCenter" | "StepLeft" | "StepRight"

    Gets or sets a value indicating the style of the line that connects data points for "Line" and "Area" plots.

    value

    "Default" indicates the straight line

    value

    "Spline" indicates the bezier curve

    value

    "StepCenter" indicates the stepped line

    value

    "StepLeft" indicates the stepped line

    value

    "StepRight" indicates the stepped line

  • Optional LineStyle?: BorderStyle

    Gets or sets a value indicating the properties of the line connecting data points for "Line" and "Area" plots, or the properties of the border of geometrical shapes for other plots.

    see

    BorderStyle

  • Optional Offset?: undefined | number

    Gets or sets a value in percentage that translates geometrical shapes of a plot.

  • Optional Opacity?: undefined | number

    Gets or sets a value in percentage indicating the opacity of geometrical shapes of a plot.

  • Optional Radial?: undefined | false | true

    Gets or sets a value indicating whether a plot has radial shape.

  • Optional Rules?: DvChartRule[]

    Gets or sets a value indicating the additional rules of plot appearance.

  • Optional ShowNulls?: "Gaps" | "Connected" | "Zeros"

    Gets or sets a value indicating the arrangement of data points for Null values.

    value

    "Gaps" indicates that the plot will prevent connection between a null data point and its previous and next points

    value

    "Zero" indicates that null data points will be considered to have 0 value

    value

    "Connected" indicates that the plot will connect the previous and the next points of a null point

  • Optional StartAngle?: undefined | number

    Gets or sets a value in arcdegree indicating the rotation of a "Pie", "PolarColumn", or "PolarBar" plot clockwise.

  • Optional Style?: undefined | { BackgroundColor?: undefined | string }

    Represents the style of geometrical shapes of a plot.

  • Optional Sweep?: undefined | number

    Gets or sets a value in arcdegree from 0 to 360 that determines the arc length occupied by a "Pie", "PolarColumn", or "PolarBar" plot.

  • Optional SymbolOpacity?: undefined | number

    Gets or sets a value in percentage indicating the opacity of symbols in a "Line" or "Area" plot.

  • Optional SymbolShape?: "Auto" | "X" | "Dot" | "Box" | "Diamond" | "Triangle" | "Dash" | "Plus"

    Gets or sets a value indicating the symbols shape for a "Line" or "Area" plot.

  • Optional SymbolStyle?: undefined | { BackgroundColor?: undefined | string; Border?: BorderStyle }

    Represents the style of symbols for a "Line" or "Area" plot.

  • Optional Symbols?: undefined | false | true

    Gets or sets a value indicating whether a "Line" or "Area" plot displays symbols.

  • Optional Text?: undefined | { ConnectingLine?: undefined | { Border?: BorderStyle }; LinePosition?: "Auto" | "Center"; Offset?: undefined | number; OverlappingLabels?: "Auto" | "Show"; Style?: undefined | { BackgroundColor?: undefined | string; Border?: BorderStyle; Color?: undefined | string; FontFamily?: undefined | string; FontSize?: undefined | string; FontStyle?: undefined | string; FontWeight?: undefined | string; TextDecoration?: undefined | string }; Template?: undefined | string; TextPosition?: "Auto" | "Center" | "Inside" | "Outside" }

    Represents properties for labels of a plot of a chart.

  • Optional Tooltip?: undefined | { Template?: undefined | string }

    Gets or sets a value or an expression indicating the text displayed when a report reader hovers over a part of a plot.

DvChartRule

DvChartRule: { Condition?: undefined | string; RuleProperties?: { TargetProperty?: "BackgroundColor" | "LineWidth" | "LineStyle" | "LineColor" | "SymbolBackgroundColor" | "SymbolLineColor" | "SymbolLineStyle" | "SymbolLineWidth" | "LabelTemplate" | "TooltipTemplate"; Value?: undefined | string }[] }

Represents the additional rules of plot appearance.

Type declaration

  • Optional Condition?: undefined | string

    Gets or sets an expression that should evaluate to a boolean value indicating whether the rule should be applied.

  • Optional RuleProperties?: { TargetProperty?: "BackgroundColor" | "LineWidth" | "LineStyle" | "LineColor" | "SymbolBackgroundColor" | "SymbolLineColor" | "SymbolLineStyle" | "SymbolLineWidth" | "LabelTemplate" | "TooltipTemplate"; Value?: undefined | string }[]

    Represents the effect of a rule.

DvChartTextStyle

DvChartTextStyle: { Color?: undefined | string; FontFamily?: undefined | string; FontSize?: undefined | string; FontStyle?: undefined | string; FontWeight?: undefined | string; TextDecoration?: undefined | string }

Represets style information for textual elements of a chart.

Type declaration

  • Optional Color?: undefined | string

    Gets or sets a value or an expression indicating the foreground color of text. The value or the expression result should be a cross-browser color name or to a hexadecimal color code, such as #face0d.

  • Optional FontFamily?: undefined | string

    Gets or sets a value or an expression indicating the name of the font family for text.

  • Optional FontSize?: undefined | string

    Gets or sets a value or an expression indicating the font size for text. The value or the expression result should be in Length units.

  • Optional FontStyle?: undefined | string

    Gets or sets a value or an expression indicating the font style for text. The value or the expression result should be one of the following.

    value

    "Normal" indicates that the font is not italicized.

    value

    "Italic" indicates that that the font is italicized.

  • Optional FontWeight?: undefined | string

    Gets or sets a value or an expression indicating the thickness of font for text. The value or the expression result should be one of the following.

    value

    "Thin" indicates a font thickness that matches CSS font weight 100

    value

    "ExtraLight" indicates a font thickness that matches CSS font weight 200

    value

    "Light" indicates a font thickness that matches CSS font weight 300

    value

    "Normal" indicates a font thickness that matches CSS font weight 400

    value

    "Medium" indicates a font thickness that matches CSS font weight 500

    value

    "SemiBold" indicates a font thickness that matches CSS font weight 600

    value

    "Bold" indicates a font thickness that matches CSS font weight 700

    value

    "ExtraBold" indicates a font thickness that matches CSS font weight 800

    value

    "Heavy" indicates a font thickness that matches CSS font weight 900

  • Optional TextDecoration?: undefined | string

    Gets or sets a value or an expression indicating text formatting. The value or the expression result should be one of the following.

    value

    "None" indicates that there is no text formatting

    value

    "Underline" indicates that the text is underlined

    value

    "Overline" indicates that the text has an overline

    value

    "LineThrough" indicates that the text has a strikethrough

DvChartTextStyleWithPadding

DvChartTextStyleWithPadding: { Color?: undefined | string; FontFamily?: undefined | string; FontSize?: undefined | string; FontStyle?: undefined | string; FontWeight?: undefined | string; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string; TextDecoration?: undefined | string }

Represets extended style information for textual elements of a chart.

Type declaration

  • Optional Color?: undefined | string

    Gets or sets a value or an expression indicating the foreground color of text. The value or the expression result should be a cross-browser color name or to a hexadecimal color code, such as #face0d.

  • Optional FontFamily?: undefined | string

    Gets or sets a value or an expression indicating the name of the font family for text.

  • Optional FontSize?: undefined | string

    Gets or sets a value or an expression indicating the font size for text. The value or the expression result should be in Length units.

  • Optional FontStyle?: undefined | string

    Gets or sets a value or an expression indicating the font style for text. The value or the expression result should be one of the following.

    value

    "Normal" indicates that the font is not italicized.

    value

    "Italic" indicates that that the font is italicized.

  • Optional FontWeight?: undefined | string

    Gets or sets a value or an expression indicating the thickness of font for text. The value or the expression result should be one of the following.

    value

    "Thin" indicates a font thickness that matches CSS font weight 100

    value

    "ExtraLight" indicates a font thickness that matches CSS font weight 200

    value

    "Light" indicates a font thickness that matches CSS font weight 300

    value

    "Normal" indicates a font thickness that matches CSS font weight 400

    value

    "Medium" indicates a font thickness that matches CSS font weight 500

    value

    "SemiBold" indicates a font thickness that matches CSS font weight 600

    value

    "Bold" indicates a font thickness that matches CSS font weight 700

    value

    "ExtraBold" indicates a font thickness that matches CSS font weight 800

    value

    "Heavy" indicates a font thickness that matches CSS font weight 900

  • Optional PaddingBottom?: undefined | string

    Gets or sets a value or an expression indicating the padding between the bottom edge of text area and its contents. The value or the expression result should be in Length units.

  • Optional PaddingLeft?: undefined | string

    Gets or sets a value or an expression indicating the padding between the left edge of text area and its contents. The value or the expression result should be in Length units.

  • Optional PaddingRight?: undefined | string

    Gets or sets a value or an expression indicating the padding between the right edge of text area and its contents. The value or the expression result should be in Length units.

  • Optional PaddingTop?: undefined | string

    Gets or sets a value or an expression indicating the padding between the top edge of text area and its contents. The value or the expression result should be in Length units.

  • Optional TextDecoration?: undefined | string

    Gets or sets a value or an expression indicating text formatting. The value or the expression result should be one of the following.

    value

    "None" indicates that there is no text formatting

    value

    "Underline" indicates that the text is underlined

    value

    "Overline" indicates that the text has an overline

    value

    "LineThrough" indicates that the text has a strikethrough

DvChartValueAggregateEncoding

DvChartValueAggregateEncoding: { Aggregate?: DvChartAggregate; Field?: { FieldType?: undefined | "Complex"; Subfields?: { Key?: undefined | string; Value?: undefined | string }[] } | { Value?: string[] } }

Represents the properties for data values of a plot of a chart.

see

DvChartEncodings

Type declaration

  • Optional Aggregate?: DvChartAggregate

    Gets or sets a value indicating the aggregate function that applies to the encoding values.

    see

    DvChartAggregate

  • Optional Field?: { FieldType?: undefined | "Complex"; Subfields?: { Key?: undefined | string; Value?: undefined | string }[] } | { Value?: string[] }

    Represents an encoding value

EmbeddedImage

EmbeddedImage: { ImageData?: undefined | string; MIMEType?: undefined | string; Name?: undefined | string }

Represent an image that is embedded within a report

Type declaration

  • Optional ImageData?: undefined | string

    Gets or sets image data in base64 format for an embedded image

  • Optional MIMEType?: undefined | string

    Get or sets the image format of an embedded image Supported values are "image/jpeg", "image/gif", "image/png", and "image/svg+xml"

  • Optional Name?: undefined | string

    Get or sets a unique identifier for an embedded image

Field

Field: { DataField?: undefined | string; Name: string; Value?: undefined | string }

Represents information about a DataSet field

see

{@link DataSet.Fields}

Type declaration

  • Optional DataField?: undefined | string

    Gets or sets the name of the field that is returned by the DataSet query

    see

    {@link DataSet.Query}

  • Name: string

    Gets or sets a unique identifier for a field

  • Optional Value?: undefined | string

    Gets or sets a value or an expression that evaluates to a value for this field

Filter

Filter: { FilterExpression: string; FilterValues: string[]; Operator: FilterOperator }

Represents a filter to apply to rows of data within a DataSet, a group, or a data region

see

{@link Grouping.Filters}

see

{@link Grouping.Filters}

Type declaration

  • FilterExpression: string

    Gets or sets an expression that is evaluated for each instance of a group, or for each row of data that is associated with a DataSet, a group, or a data region. This expression is then compared to the value of the FilterValues element by using the Operator. Failed comparisons result in the row or instance being filtered out of its containing group, dataset, or data region.

  • FilterValues: string[]

    Gets or sets the values to compare to a FilterExpression

  • Operator: FilterOperator

    Gets or sets an operator to use to compare the values of FilterExpression and FilterValues

    see

    FilterOperator

FilterOperator

FilterOperator: "Between" | "Equal" | "Like" | "NotEqual" | "GreaterThan" | "GreaterThanOrEqual" | "LessThan" | "LessThanOrEqual" | "TopN" | "BottomN" | "TopPercent" | "BottomPercent" | "In"

Represents the opeator to use to compare the values of Filer.FilterExpression and Filter.FilterValues

see

Filter

FixedPageSection

FixedPageSection: { ReportItems?: ReportItem[]; Style?: undefined | { BackgroundColor?: undefined | string; BackgroundImage?: BackgroundImage; Border?: BorderStyle; BottomBorder?: BorderStyle; LeftBorder?: BorderStyle; RightBorder?: BorderStyle; TopBorder?: BorderStyle }; ThrowIfPlaceHoldersEmpty?: undefined | false | true; Visibility?: Visibility }

Represents the structure and layout information for a page of a fixed layout report

Type declaration

  • Optional ReportItems?: ReportItem[]

    Gets or sets the collection of report items contained in a fixed page

    see

    ReportItem

  • Optional Style?: undefined | { BackgroundColor?: undefined | string; BackgroundImage?: BackgroundImage; Border?: BorderStyle; BottomBorder?: BorderStyle; LeftBorder?: BorderStyle; RightBorder?: BorderStyle; TopBorder?: BorderStyle }

    Represents appearance information for a fixed page

  • Optional ThrowIfPlaceHoldersEmpty?: undefined | false | true
  • Optional Visibility?: Visibility

Grouping

Grouping: { DocumentMapLabel?: undefined | string; Filters?: Filter[]; GroupExpressions?: string[]; Name?: undefined | string; NewSection?: undefined | false | true; PageBreak?: "None" | "Start" | "End" | "StartAndEnd" | "Between"; PageBreakDisabled?: undefined | string; ParentGroup?: undefined | string }

Represents information about data categorization

Type declaration

  • Optional DocumentMapLabel?: undefined | string

    Gets or sets an expression indicating the text of a link to the instance of grouping in the Report Map

  • Optional Filters?: Filter[]

    Gets or sets a collection of filters to be applied to the data for each instance of a grouping

    see

    Filter

  • Optional GroupExpressions?: string[]

    Gets or sets the collection of expressions by which to group the data in a grouping.

  • Optional Name?: undefined | string

    Gets or sets a unique identifier for a grouping

  • Optional NewSection?: undefined | false | true

    Gets or sets a value indicating whether each instance of a grouping has its page numbering.

  • Optional PageBreak?: "None" | "Start" | "End" | "StartAndEnd" | "Between"

    Gets or sets a value indicating the location of page breaks generated by instances of a grouping.

    value

    "None" indicates that no page breaks are generated.

    value

    "Start" indicates each instance of a grouping inserts the page break before its content

    value

    "End" indicates each instance of a grouping inserts the page break after its content

    value

    "StartAndEnd" indicates each instance of a grouping inserts the page break before and after its content

    value

    "Between" indicates each instance of a grouping starts on a new page

  • Optional PageBreakDisabled?: undefined | string

    Gets or sets an expression that evaluates to a value indicating whether the page break option should be ignored

  • Optional ParentGroup?: undefined | string

    Gets or sets an expression that identifies the parent group in a recursive hierarchy

Image

Image: { Action?: Action; Bookmark?: undefined | string; Height?: undefined | string; HorizontalAlignment?: undefined | string; Label?: undefined | string; Left?: undefined | string; MIMEType?: undefined | string; Name: string; Sizing?: "Clip" | "Fit" | "AutoSize" | "FitProportional"; Source?: "External" | "Embedded" | "Database"; Style?: undefined | { Border?: BorderStyle; BottomBorder?: BorderStyle; LeftBorder?: BorderStyle; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string; RightBorder?: BorderStyle; TopBorder?: BorderStyle }; ToolTip?: undefined | string; Top?: undefined | string; Type: "image"; Value?: undefined | string; VerticalAlignment?: undefined | string; Visibility?: Visibility; Width?: undefined | string; ZIndex?: undefined | number }

Represents properties for an Image in a Report.

Type declaration

  • Optional Action?: Action

    Gets or sets an action (such as hyperlinks) that is associated with an Image.

  • Optional Bookmark?: undefined | string

    Gets or sets a value or an expression indicating the Id of an Image for a Jump To Bookmark interactivity action.

  • Optional Height?: undefined | string

    Gets or sets a value in Length units indicating the height of an Image

  • Optional HorizontalAlignment?: undefined | string

    Gets or sets a value or expression indicating the horizontal alignment for the actual image within an Image report item. The value or the expression result should be one of the following.

    value

    "Left" indicates that an Image aligns the actual image to the left

    value

    "Center" indicates that an Image centers the actual image

    value

    "Right" indicates that an Image aligns the actual image to the right

  • Optional Label?: undefined | string

    Gets or sets a value or an expression indicating the text associated with an Image that appears in the Report Map and Table of Contents

  • Optional Left?: undefined | string

    Gets or sets a value in Length units indicating the distance of an Image from the left of the image's container

  • Optional MIMEType?: undefined | string

    Get or sets the image format of an Image. Supported values are "image/jpeg", "image/gif", "image/png", and "image/svg+xml".

  • Name: string

    Gets or sets a unique identifier for an image

  • Optional Sizing?: "Clip" | "Fit" | "AutoSize" | "FitProportional"

    Gets or sets a value indicating the behavior of an Image if the actual image does not fit within the specified size of the image.

    value

    "AutoSize" indicates that the border of the image will grow or shrink to accommodate the dimensions of the actual image.

    value

    "Fit" indicates that the actual image is resized to exactly match both the Height and Width dimensions of an Image report item.

    value

    "FitProportional" indicates that the actual image is resized to fit within the image dimensions, while preserving the aspect ratio.

    value

    "Clip" indicates that the actual image is clipped to fit the dimensions of the image report item.

  • Optional Source?: "External" | "Embedded" | "Database"

    Gets or sets the type of source for an Image

    value

    "External" indicates that the Value property must contain a string constant or an expression that evaluates to the location of an image.

    value

    "Embedded" indicates that the Value property must contain a string constant or an expression that evaluates to the name of an embedded image in the report.

    value

    "Database" indicates that the Value property contain an expression (such as a field in the database) that evaluates to the binary data for an image.

  • Optional Style?: undefined | { Border?: BorderStyle; BottomBorder?: BorderStyle; LeftBorder?: BorderStyle; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string; RightBorder?: BorderStyle; TopBorder?: BorderStyle }

    Represents style information for an Image.

  • Optional ToolTip?: undefined | string

    Gets or sets a value or an expression indicating the text displayed when a report reader hovers over an Image at preview time

  • Optional Top?: undefined | string

    Gets or sets a value in Length units indicating the distance of an Image from the top of the image's container

  • Type: "image"

    Should be set to "image"

  • Optional Value?: undefined | string

    Gets or sets a value indicating location or the actual data of an image, depending on the value of the Source property.

  • Optional VerticalAlignment?: undefined | string

    Gets or sets a value or expression indicating the vertical alignment for the actual image within an Image report item. The value or the expression result should be one of the following.

    value

    "Top" indicates top-aligned image

    value

    "Middle" indicates vertically-centered image alignment

    value

    "Bottom" indicates bottom-aligned image

  • Optional Visibility?: Visibility

    Gets or sets a value indicating whether an Image is hidden

    see

    Visibility

  • Optional Width?: undefined | string

    Gets or sets a value in Length units indicating the width of an Image

  • Optional ZIndex?: undefined | number

    Gets or sets a value indicating the stack order of an Image

InputField

Represents the input control for fillable PDF forms.

InputFieldCheckbox

InputFieldCheckbox: { Bookmark?: undefined | string; CheckSize?: undefined | string; CheckStyle?: "Cross" | "Diamond" | "Square" | "Check" | "Circle" | "Star"; Checked?: undefined | string; FieldName?: undefined | string; Height?: undefined | string; Label?: undefined | string; Left?: undefined | string; Name: string; Readonly?: undefined | false | true; Required?: undefined | false | true; Style?: undefined | { BackgroundColor?: undefined | string; Border?: BorderStyle; BottomBorder?: BorderStyle; Color?: undefined | string; LeftBorder?: BorderStyle; RightBorder?: BorderStyle; TextAlign?: undefined | string; TopBorder?: BorderStyle }; ToolTip?: undefined | string; Top?: undefined | string; Type: "inputfield"; Visibility?: Visibility; Width?: undefined | string; ZIndex?: undefined | number }

Represents properties for a checkbox Input Field

Type declaration

  • Optional Bookmark?: undefined | string

    Gets or sets a value or an expression indicating the Id of an Input Field for a Jump To Bookmark interactivity action.

  • Optional CheckSize?: undefined | string

    Gets or sets a value or an expression indicating the size of the check mark for a Checkbox Input Field. The value or the expression result should be in Length units.

  • Optional CheckStyle?: "Cross" | "Diamond" | "Square" | "Check" | "Circle" | "Star"

    Gets or sets a value indicating the style of the check mark for a CheckBox Input Field.

  • Optional Checked?: undefined | string

    Gets or sets a value or an expression indicating whether a Checkbox Input Field is initially checked.

  • Optional FieldName?: undefined | string

    Gets or sets the name of a field in the fillable PDF form

  • Optional Height?: undefined | string

    Gets or sets a value in Length units indicating the height of an Input Field.

  • Optional Label?: undefined | string

    Gets or sets a value or an expression indicating the text associated with an Input Field that appears in the Report Map and Table of Contents

  • Optional Left?: undefined | string

    Gets or sets a value in Length units indicating the distance of an Input Field from the left of the field's container

  • Name: string

    Gets or sets a unique identifier for an Input Field

  • Optional Readonly?: undefined | false | true

    Gets or sets a value indicating whether a PDF document reader is allowed to modify the field's value.

  • Optional Required?: undefined | false | true

    Gets or sets a value indicating whether a PDF document reader must provide the field's value.

  • Optional Style?: undefined | { BackgroundColor?: undefined | string; Border?: BorderStyle; BottomBorder?: BorderStyle; Color?: undefined | string; LeftBorder?: BorderStyle; RightBorder?: BorderStyle; TextAlign?: undefined | string; TopBorder?: BorderStyle }

    Represents style information for an Input Field.

  • Optional ToolTip?: undefined | string

    Gets or sets a value or an expression indicating the text displayed when a report reader hovers over an Input Field at preview time

  • Optional Top?: undefined | string

    Gets or sets a value in Length units indicating the distance of an Input Field from the top of the field's container

  • Type: "inputfield"

    Should be set to "inputfield"

  • Optional Visibility?: Visibility

    Gets or sets a value indicating whether an Input Field is hidden

    see

    Visibility

  • Optional Width?: undefined | string

    Gets or sets a value in Length units indicating the width of an Input Field.

  • Optional ZIndex?: undefined | number

    Gets or sets a value indicating the stack order of an Input Field

InputFieldText

InputFieldText: { Bookmark?: undefined | string; FieldName?: undefined | string; Height?: undefined | string; Label?: undefined | string; Left?: undefined | string; MaxLength?: undefined | number; Multiline?: undefined | false | true; Name: string; Password?: undefined | false | true; Readonly?: undefined | false | true; Required?: undefined | false | true; SpellCheck?: undefined | false | true; Style?: undefined | { BackgroundColor?: undefined | string; Border?: BorderStyle; BottomBorder?: BorderStyle; Color?: undefined | string; FontFamily?: undefined | string; FontSize?: undefined | string; FontStyle?: undefined | string; FontWeight?: undefined | string; Format?: undefined | string; LeftBorder?: BorderStyle; RightBorder?: BorderStyle; TextAlign?: undefined | string; TopBorder?: BorderStyle }; ToolTip?: undefined | string; Top?: undefined | string; Type: "inputfield"; Value?: undefined | string; Visibility?: Visibility; Width?: undefined | string; ZIndex?: undefined | number }

Represents properties for a text Input Field

Type declaration

  • Optional Bookmark?: undefined | string

    Gets or sets a value or an expression indicating the Id of an Input Field for a Jump To Bookmark interactivity action.

  • Optional FieldName?: undefined | string

    Gets or sets the name of an Input Field in the fillable PDF form

  • Optional Height?: undefined | string

    Gets or sets a value in Length units indicating the height of an Input Field.

  • Optional Label?: undefined | string

    Gets or sets a value or an expression indicating the text associated with an Input Field that appears in the Report Map and Table of Contents

  • Optional Left?: undefined | string

    Gets or sets a value in Length units indicating the distance of an Input Field from the left of the field's container

  • Optional MaxLength?: undefined | number

    Gets or sets a value indicating the maximum allowed length of the field's value.

  • Optional Multiline?: undefined | false | true

    Gets or sets a value indicating whether a multi-line value for a field is accepted.

  • Name: string

    Gets or sets a unique identifier for an Input Field

  • Optional Password?: undefined | false | true

    Gets or sets a value indicating whether the fillable PDF form displays the field's value as a series of asterisks.

  • Optional Readonly?: undefined | false | true

    Gets or sets a value indicating whether a PDF document reader is allowed to modify the field's value.

  • Optional Required?: undefined | false | true

    Gets or sets a value indicating whether a PDF document reader must provide the field's value.

  • Optional SpellCheck?: undefined | false | true

    Gets or sets a value indicating whether the field's value is handled by spell-check.

  • Optional Style?: undefined | { BackgroundColor?: undefined | string; Border?: BorderStyle; BottomBorder?: BorderStyle; Color?: undefined | string; FontFamily?: undefined | string; FontSize?: undefined | string; FontStyle?: undefined | string; FontWeight?: undefined | string; Format?: undefined | string; LeftBorder?: BorderStyle; RightBorder?: BorderStyle; TextAlign?: undefined | string; TopBorder?: BorderStyle }

    Represents style information for an Input Field.

  • Optional ToolTip?: undefined | string

    Gets or sets a value or an expression indicating the text displayed when a report reader hovers over an Input Field at preview time

  • Optional Top?: undefined | string

    Gets or sets a value in Length units indicating the distance of an Input Field from the top of the field's container

  • Type: "inputfield"

    Should be set to "inputfield"

  • Optional Value?: undefined | string

    Gets or sets a value or an expression indicating the initial field's value.

  • Optional Visibility?: Visibility

    Gets or sets a value indicating whether an Input Field is hidden

    see

    Visibility

  • Optional Width?: undefined | string

    Gets or sets a value in Length units indicating the width of an Input Field.

  • Optional ZIndex?: undefined | number

    Gets or sets a value indicating the stack order of an Input Field

Layer

Layer: { DesignerLock?: undefined | false | true; DesignerTransparency?: undefined | number; DesignerVisible?: undefined | false | true; Name: string; TargetDevice?: undefined | string }

Type declaration

  • Optional DesignerLock?: undefined | false | true
  • Optional DesignerTransparency?: undefined | number
  • Optional DesignerVisible?: undefined | false | true
  • Name: string
  • Optional TargetDevice?: undefined | string

Line

Line: { Bookmark?: undefined | string; EndPoint?: undefined | { X?: undefined | string; Y?: undefined | string }; Label?: undefined | string; LineColor?: undefined | string; LineStyle?: undefined | string; LineWidth?: undefined | string; Name: string; StartPoint?: undefined | { X?: undefined | string; Y?: undefined | string }; Type: "line"; Visibility?: Visibility; ZIndex?: undefined | number }

Represents properties for a Line in a report

Type declaration

  • Optional Bookmark?: undefined | string

    Gets or sets a value or an expression indicating the Id of a Line for a Jump To Bookmark interactivity action.

  • Optional EndPoint?: undefined | { X?: undefined | string; Y?: undefined | string }

    Represents the end point of a line

  • Optional Label?: undefined | string

    Gets or sets a value or an expression indicating the text associated with a Line that appears in the Report Map and Table of Contents

  • Optional LineColor?: undefined | string

    Gets or sets a value or an expression that evaluates to the color of a Line The value or the expression result should be either a cross-browser color name or to a hexadecimal color code, such as #face0d.

  • Optional LineStyle?: undefined | string

    Gets or sets expression that evaluates to the style of a Line

    value

    "None" indicates that no border is drawn.

    value

    "Dotted" indicates a dotted line for a border.

    value

    "Dashed" indicates a dashed line for a border.

    value

    "Solid" indicates a solid line for a border.

    value

    "Double" indicates a double solid line for a border.

    value

    "Groove" indicates a 3D grooved border. The effect depends on the border color value.

    value

    "Ridge" indicates a 3D ridged border. The effect depends on the border color value.

    value

    "Inset" indicates a 3D inset border. The effect depends on the border color value.

    value

    "Outset" indicates a 3D outset border. The effect depends on the border color value.

  • Optional LineWidth?: undefined | string

    Gets or sets a value or an expression that evaluates to the width of a Line The value or the expression result should be in Length units

  • Name: string

    Gets or sets a unique identifier for a Line

  • Optional StartPoint?: undefined | { X?: undefined | string; Y?: undefined | string }

    Represents the start point of a line

  • Type: "line"

    Should be set to "line"

  • Optional Visibility?: Visibility

    Gets or sets a value indicating whether a Line is hidden

    see

    Visibility

  • Optional ZIndex?: undefined | number

    Gets or sets a value indicating the stack order of a Line

List

List: { Bookmark?: undefined | string; ConsumeWhiteSpace?: undefined | false | true; DataSetName?: undefined | string; Filters?: Filter[]; FixedHeight?: undefined | string; FixedWidth?: undefined | string; Group?: Grouping; Height?: undefined | string; KeepTogether?: undefined | false | true; Label?: undefined | string; Left?: undefined | string; Name: string; NewSection?: undefined | false | true; NoRowsMessage?: undefined | string; OverflowName?: undefined | string; PageBreak?: "None" | "Start" | "End" | "StartAndEnd" | "Between"; ReportItems?: ReportItem[]; SortExpressions?: SortExpression[]; Style?: undefined | { BackgroundColor?: undefined | string; BackgroundImage?: BackgroundImage; Border?: BorderStyle; BottomBorder?: BorderStyle; Color?: undefined | string; Direction?: undefined | string; FontFamily?: undefined | string; FontSize?: undefined | string; FontStyle?: undefined | string; FontWeight?: undefined | string; Format?: undefined | string; Language?: undefined | string; LeftBorder?: BorderStyle; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string; RightBorder?: BorderStyle; TextAlign?: undefined | string; TextDecoration?: undefined | string; TopBorder?: BorderStyle; VerticalAlign?: undefined | string; WritingMode?: undefined | string }; ToolTip?: undefined | string; Top?: undefined | string; Type: "list"; Visibility?: Visibility; Width?: undefined | string; ZIndex?: undefined | number }

Represents properties for a List in a report

Type declaration

  • Optional Bookmark?: undefined | string

    Gets or sets a value or an expression indicating the Id of a List for a Jump To Bookmark interactivity action.

  • Optional ConsumeWhiteSpace?: undefined | false | true

    Gets or sets a value indicating whether all whitespace in a List should be consumed when contents grow

  • Optional DataSetName?: undefined | string

    Gets or sets the name of the dataset to use to bind data to a List.

  • Optional Filters?: Filter[]

    Gets or sets a value indicating a collection of filters to be applied to the data for each row of a List

    see

    Filter

  • Optional FixedHeight?: undefined | string

    Gets or sets a value in Length units indicating the fixed height of a List

  • Optional FixedWidth?: undefined | string

    Gets or sets a value in Length units indicating the fixed width of a List

  • Optional Group?: Grouping

    Gets or sets a value indicating the expressions by which to group the data in a List

    see

    Grouping

  • Optional Height?: undefined | string

    Gets or sets a value in Length units indicating the height of a List

  • Optional KeepTogether?: undefined | false | true

    Gets or sets a value indicating whether the entire contents of a List should be kept together on one Page if possible

  • Optional Label?: undefined | string

    Gets or sets a value or an expression indicating the text associated with a List that appears in the Report Map and Table of Contents

  • Optional Left?: undefined | string

    Gets or sets a value in Length units indicating the distance of a List from the left of the list's container

  • Name: string

    Gets or sets a unique identifier for a List

  • Optional NewSection?: undefined | false | true

    Gets or sets a value indicating a List has its page numbering

  • Optional NoRowsMessage?: undefined | string

    Gets or sets a value or an expression indicating text to render instead of the list layout when no rows of data are available for a List.

  • Optional OverflowName?: undefined | string

    Gets or sets a value indicating the name of the overflow place holder for a fixed List layout.

  • Optional PageBreak?: "None" | "Start" | "End" | "StartAndEnd" | "Between"

    Gets or sets a value indicating the location of a page breaks generated by a List

  • Optional ReportItems?: ReportItem[]

    Gets or sets a value indicating a collection of the report items within a List

  • Optional SortExpressions?: SortExpression[]

    Gets or sets a value indicating a collection of expressions by which to sort repeated list regions

    see

    SortExpression

  • Optional Style?: undefined | { BackgroundColor?: undefined | string; BackgroundImage?: BackgroundImage; Border?: BorderStyle; BottomBorder?: BorderStyle; Color?: undefined | string; Direction?: undefined | string; FontFamily?: undefined | string; FontSize?: undefined | string; FontStyle?: undefined | string; FontWeight?: undefined | string; Format?: undefined | string; Language?: undefined | string; LeftBorder?: BorderStyle; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string; RightBorder?: BorderStyle; TextAlign?: undefined | string; TextDecoration?: undefined | string; TopBorder?: BorderStyle; VerticalAlign?: undefined | string; WritingMode?: undefined | string }

    Represents style information for a List

  • Optional ToolTip?: undefined | string

    Gets or sets a value or an expression indicating the text displayed when a report reader hovers over a List at preview time

  • Optional Top?: undefined | string

    Gets or sets a value in Length units indicating the distance of a List from the top of the list's container

  • Type: "list"

    Should be set to "list"

  • Optional Visibility?: Visibility

    Gets or sets a value indicating whether a List is hidden

    see

    Visibility

  • Optional Width?: undefined | string

    Gets or sets a value in Length units indicating the width of a List

  • Optional ZIndex?: undefined | number

    Gets or sets a value indicating the stack order of a List

OverflowPlaceholder

OverflowPlaceholder: { Height?: undefined | string; Left?: undefined | string; Name: string; OverflowName?: undefined | string; Top?: undefined | string; Type: "overflowplaceholder"; Width?: undefined | string }

Represents properties for an Overflow Place Holder in a report

Type declaration

  • Optional Height?: undefined | string

    Gets or sets a value in Length units indicating the height of an Overflow Place Holder.

  • Optional Left?: undefined | string

    Gets or sets a value in Length units indicating the distance of an Overflow Place Holder from the left of its container

  • Name: string

    Gets or sets a unique identifier for an Overflow Place Holder

  • Optional OverflowName?: undefined | string

    Gets or sets the name of the OverflowPlaceHolder that should be used in case of more data needs to be arranged. Check the Fixed Page Layout documentation for more information.

  • Optional Top?: undefined | string

    Gets or sets a value in Length units indicating the distance of an Overflow Place Holder from the top of its container

  • Type: "overflowplaceholder"

    Should be set to "overflowplaceholder"

  • Optional Width?: undefined | string

    Gets or sets a value in Length units indicating the width of an Overflow Place Holder.

Page

Page: { BottomMargin?: undefined | string; ColumnSpacing?: undefined | string; Columns?: undefined | number; LeftMargin?: undefined | string; PageHeight?: undefined | string; PageWidth?: undefined | string; RightMargin?: undefined | string; TopMargin?: undefined | string }

Represents the structure and layout information of report pages

Type declaration

  • Optional BottomMargin?: undefined | string

    Gets or sets the width of the bottom margin of a page in Length units

    default

    "1in"

  • Optional ColumnSpacing?: undefined | string

    Gets or sets the spacing between each column for a multi-column rendering of a report in Length units

    default

    "0in"

  • Optional Columns?: undefined | number

    Gets or sets the default number of columns used to render a report

    default

    1

  • Optional LeftMargin?: undefined | string

    Gets or sets the width of the left margin of a page in Length units

    default

    "1in"

  • Optional PageHeight?: undefined | string

    Gets or sets the height for rendering in Length units

    default

    "11in"

  • Optional PageWidth?: undefined | string

    Gets or sets the width for rendering in Length units

    default

    "8.5in"

  • Optional RightMargin?: undefined | string

    Gets or sets the width of the right margin of a page in Length units

    default

    "1in"

  • Optional TopMargin?: undefined | string

    Gets or sets the width of the top margin of a page in Length units

    default

    "1in"

PageSection

PageSection: { Height?: undefined | string; Name?: undefined | string; PrintOnFirstPage?: undefined | false | true; PrintOnLastPage?: undefined | false | true; ReportItems?: ReportItem[]; Style?: undefined | { BackgroundColor?: undefined | string; BackgroundImage?: BackgroundImage; Border?: BorderStyle; BottomBorder?: BorderStyle; LeftBorder?: BorderStyle; RightBorder?: BorderStyle; TopBorder?: BorderStyle } }

Represents the structure and layout information for the page header or page footer

Type declaration

  • Optional Height?: undefined | string

    Gets or sets the height of a page section in Length units

  • Optional Name?: undefined | string

    Get or sets a unique identifier for a page section

  • Optional PrintOnFirstPage?: undefined | false | true

    Get or sets the value indicating whether the page header or page footer is shown on the first rendered page in a report

  • Optional PrintOnLastPage?: undefined | false | true

    Get or sets the value indicating whether the page header or page footer is shown on the last rendered page in a report

  • Optional ReportItems?: ReportItem[]

    Gets or sets the collection of report items contained in a page section

    see

    ReportItem

  • Optional Style?: undefined | { BackgroundColor?: undefined | string; BackgroundImage?: BackgroundImage; Border?: BorderStyle; BottomBorder?: BorderStyle; LeftBorder?: BorderStyle; RightBorder?: BorderStyle; TopBorder?: BorderStyle }

    Represents appearance information for a page section

ParameterValue

ParameterValue: { Label?: undefined | string; Value?: undefined | string }

Defines parameter value

see

{@link ReportParameter.ValidValues}

Type declaration

  • Optional Label?: undefined | string

    Gets or sets the text to use to describe the report parameter value to display in a parameter drop-down at runtime

  • Optional Value?: undefined | string

    Gets or sets the value for a report parameter

Query

Query: { CommandText?: undefined | string; DataSourceName: string }

Represents the information that is necessary to execute and retrieve data for a DataSet

see

{@link DataSet.Query}

Type declaration

  • Optional CommandText?: undefined | string

    Gets or sets the query to execute to obtain data for a DataSet

  • DataSourceName: string

    Gets or sets the name of a data source against which to execute a query

    see

    DataSource

Rectangle

Rectangle: { Bookmark?: undefined | string; ConsumeWhiteSpace?: undefined | false | true; Height?: undefined | string; KeepTogether?: undefined | false | true; Label?: undefined | string; Left?: undefined | string; Name: string; PageBreak?: "None" | "Start" | "End" | "StartAndEnd" | "Between"; ReportItems?: ReportItem[]; RoundingRadius?: RoundingRadius; Style?: undefined | { BackgroundColor?: undefined | string; BackgroundImage?: BackgroundImage; Border?: BorderStyle; BottomBorder?: BorderStyle; LeftBorder?: BorderStyle; RightBorder?: BorderStyle; TopBorder?: BorderStyle }; ToolTip?: undefined | string; Top?: undefined | string; Type: "rectangle"; Visibility?: Visibility; Width?: undefined | string; ZIndex?: undefined | number }

Represents properties for a Container in a report

Type declaration

  • Optional Bookmark?: undefined | string

    Gets or sets a value or an expression indicating the Id of a Container for a Jump To Bookmark interactivity action.

  • Optional ConsumeWhiteSpace?: undefined | false | true

    Gets or sets a value indicating whether all whitespace in a Container should be consumed when contents grow

  • Optional Height?: undefined | string

    Gets or sets a value in Length units indicating the height of a Container

  • Optional KeepTogether?: undefined | false | true

    Gets or sets a value indicating whether the entire contents of a Container should be kept together on one Page if possible

  • Optional Label?: undefined | string

    Gets or sets a value or an expression indicating the text associated with a Container that appears in the Report Map and Table of Contents

  • Optional Left?: undefined | string

    Gets or sets a value in Length units indicating the distance of a Container from the left of the container's container

  • Name: string

    Gets or sets a unique identifier for a Rectangle

  • Optional PageBreak?: "None" | "Start" | "End" | "StartAndEnd" | "Between"

    Gets or sets a value indicating the location of a page breaks generated by a Container

  • Optional ReportItems?: ReportItem[]

    Gets or sets a value indicating a collection of report items that are contained within a Container

    see

    ReportItem

  • Optional RoundingRadius?: RoundingRadius

    Gets or sets a value indicating the container's border radius.

    see

    RoundingRadius

  • Optional Style?: undefined | { BackgroundColor?: undefined | string; BackgroundImage?: BackgroundImage; Border?: BorderStyle; BottomBorder?: BorderStyle; LeftBorder?: BorderStyle; RightBorder?: BorderStyle; TopBorder?: BorderStyle }

    Represents style information for a Container

  • Optional ToolTip?: undefined | string

    Gets or sets a value or an expression indicating the text displayed when a report reader hovers over a Container at preview time

  • Optional Top?: undefined | string

    Gets or sets a value in Length units indicating the distance of a Container from the top of the container's container

  • Type: "rectangle"

    Should be set to "rectangle"

  • Optional Visibility?: Visibility

    Gets or sets a value indicating whether a Container is hidden

    see

    Visibility

  • Optional Width?: undefined | string

    Gets or sets a value in Length units indicating the width of a Container

  • Optional ZIndex?: undefined | number

    Gets or sets a value indicating the stack order of a Container

Report

Report: { Author?: undefined | string; Body?: Body; ConsumeContainerWhitespace?: undefined | false | true; DataSets?: DataSet[]; DataSources?: DataSource[]; Description?: undefined | string; DocumentMap?: DocumentMap; EmbeddedImages?: EmbeddedImage[]; FixedPage?: undefined | { DataSetName?: undefined | string; Filters?: Filter[]; Group?: Grouping; Pages?: FixedPageSection[]; SortExpressions?: SortExpression[] }; Language?: undefined | string; Name?: undefined | string; Page?: Page; PageFooter?: PageSection; PageHeader?: PageSection; ReportParameters?: ReportParameter[]; StartPageNumber?: undefined | number; ThemeUri?: undefined | string; Themes?: string[]; Width?: undefined | string }

Report info

Type declaration

  • Optional Author?: undefined | string

    Gets or sets the author of a Report

  • Optional Body?: Body

    Gets or sets a value indicating properties for the body of report pages.

    see

    Body

  • Optional ConsumeContainerWhitespace?: undefined | false | true

    Gets or sets a value indicating whether all whitespace in a report should be consumed when contents grow

  • Optional DataSets?: DataSet[]

    Gets or sets a value indicating a collection of data sets of a report.

    see

    DataSource

  • Optional DataSources?: DataSource[]

    Gets or sets a value indicating a collection of data sources of a report.

    see

    DataSource

  • Optional Description?: undefined | string

    Gets or sets the description of a Report

  • Optional DocumentMap?: DocumentMap

    Gets or sets a value indicating properties for the map of a report.

    see

    DocumentMap

  • Optional EmbeddedImages?: EmbeddedImage[]

    Gets or sets a value indicating a collection of embedded images of a report.

    see

    EmbeddedImage

  • Optional FixedPage?: undefined | { DataSetName?: undefined | string; Filters?: Filter[]; Group?: Grouping; Pages?: FixedPageSection[]; SortExpressions?: SortExpression[] }

    Represents properties for a fixed page layout.

  • Optional Language?: undefined | string

    Gets or sets a value or an expression indicating the default language to use for dates and number formatting within a report.

  • Optional Name?: undefined | string

    Gets or sets a unique identifier for a Report

  • Optional Page?: Page

    Gets or sets a value indicating the structure and layout information of report pages.

    see

    Page

  • Optional PageFooter?: PageSection

    Gets or sets a value indicating properties for the footer of report pages.

    see

    PageSection

  • Optional PageHeader?: PageSection

    Gets or sets a value indicating properties for the header of report pages.

    see

    PageSection

  • Optional ReportParameters?: ReportParameter[]

    Gets or sets a value indicating a collection of parameters of a report.

    see

    ReportParameter

  • Optional StartPageNumber?: undefined | number

    Gets or sets a value indicating the number of the first page for page numbering of a report.

  • Optional ThemeUri?: undefined | string

    Gets or sets a value indicating the location of a report theme

  • Optional Themes?: string[]

    Gets or sets a value indicating a collection of themes available for a report

  • Optional Width?: undefined | string

    Gets or sets a value in Length units indicating the width of the body of a report.

ReportItem

Represents supported Report Item Types

ReportItemType

ReportItemType: "textbox" | "checkbox" | "list" | "table" | "tablix" | "line" | "rectangle" | "bandedlist" | "subreport" | "shape" | "tableofcontents" | "barcode" | "dvchart" | "image" | "bullet" | "formattedtext" | "inputfield" | "sparkline" | "richtext" | "overflowplaceholder"

Represents names of supported Report Item Types

ReportParameter

ReportParameter: { AllowBlank?: undefined | false | true; DataType: "String" | "Boolean" | "Date" | "DateTime" | "Integer" | "Float"; DefaultValue?: DefaultValue; Hidden?: undefined | false | true; MultiValue?: undefined | false | true; Multiline?: undefined | false | true; Name: string; Nullable?: undefined | false | true; Prompt?: undefined | string; SelectAllValue?: undefined | string; ValidValues?: ValidValues }

Represents information about a parameter to a report

Type declaration

  • Optional AllowBlank?: undefined | false | true

    Get or sets a value indicating whether an empty string is allowed as a value for a report parameter

  • DataType: "String" | "Boolean" | "Date" | "DateTime" | "Integer" | "Float"

    Gets or sets the data type of a report parameter

  • Optional DefaultValue?: DefaultValue

    Get or sets the default value or values to use for a report parameter if values are not provided by the user

    see

    DefaultValue

  • Optional Hidden?: undefined | false | true

    Gets or sets a value indicating whether a report parameter is not displayed to the user at runtime

  • Optional MultiValue?: undefined | false | true

    Gets or sets a value indicating whether a report parameter can take a set of values rather than a single value

  • Optional Multiline?: undefined | false | true

    Gets or sets a value indicating whether the input control for a report parameter value allows multiple lines

  • Name: string

    Gets or sets a unique identifier for a report parameter

  • Optional Nullable?: undefined | false | true

    Gets or sets a value indicating whether the value of a report parameter can be null

  • Optional Prompt?: undefined | string

    Get or sets the text to use when prompting the user to provide the value or values for a report parameter

  • Optional SelectAllValue?: undefined | string

    Gets or sets the text that appears for the "Select All" option for the input of a multi-value report parameter

  • Optional ValidValues?: ValidValues

    Gets or sets the possible values that can be used for the a report parameter

Richtext

Richtext: RichtextPara | RichtextHtml

RichtextHtml

RichtextHtml: { Bookmark?: undefined | string; CanGrow?: undefined | false | true; Height?: undefined | string; KeepTogether?: undefined | false | true; Label?: undefined | string; Left?: undefined | string; Name: string; Style?: undefined | { BackgroundColor?: undefined | string; BackgroundImage?: BackgroundImage; Border?: BorderStyle; BottomBorder?: BorderStyle; Color?: undefined | string; FontFamily?: undefined | string; FontSize?: undefined | string; FontStyle?: undefined | string; FontWeight?: undefined | string; LeftBorder?: BorderStyle; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string; RightBorder?: BorderStyle; TopBorder?: BorderStyle }; ToolTip?: undefined | string; Top?: undefined | string; Type: "richtext"; Value?: undefined | string; Visibility?: Visibility; Width?: undefined | string; ZIndex?: undefined | number }

Represents properties for a RichText in a report

Type declaration

  • Optional Bookmark?: undefined | string

    Gets or sets a value or an expression indicating the Id of a RichText for a Jump To Bookmark interactivity action.

  • Optional CanGrow?: undefined | false | true

    Gets or sets a value indicating whether the height of a RichText can increase to match its contents

  • Optional Height?: undefined | string

    Gets or sets a value in Length units indicating the height of a RichText

  • Optional KeepTogether?: undefined | false | true

    Gets or sets a value indicating whether the entire contents of a RichText should be kept together on one Page if possible

  • Optional Label?: undefined | string

    Gets or sets a value or an expression indicating the text associated with a RichText that appears in the Report Map and Table of Contents

  • Optional Left?: undefined | string

    Gets or sets a value in Length units indicating the distance of a RichText from the left of the richtext's container

  • Name: string

    Gets or sets a unique identifier for a RichText

  • Optional Style?: undefined | { BackgroundColor?: undefined | string; BackgroundImage?: BackgroundImage; Border?: BorderStyle; BottomBorder?: BorderStyle; Color?: undefined | string; FontFamily?: undefined | string; FontSize?: undefined | string; FontStyle?: undefined | string; FontWeight?: undefined | string; LeftBorder?: BorderStyle; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string; RightBorder?: BorderStyle; TopBorder?: BorderStyle }

    Represents style information for a RichText

  • Optional ToolTip?: undefined | string

    Gets or sets a value or an expression indicating the text displayed when a report reader hovers over a RichText at preview time

  • Optional Top?: undefined | string

    Gets or sets a value in Length units indicating the distance of a RichText from the top of the richtext's container

  • Type: "richtext"

    Should be set to "richtext"

  • Optional Value?: undefined | string

    Gets or sets a value or an expression that is displayed for a RichText.

  • Optional Visibility?: Visibility

    Gets or sets a value indicating whether a RichText is hidden

    see

    Visibility

  • Optional Width?: undefined | string

    Gets or sets a value in Length units indicating the width of a RichText

  • Optional ZIndex?: undefined | number

    Gets or sets a value indicating the stack order of a RichText.

RoundingRadius

RoundingRadius: { BottomLeft?: undefined | string; BottomRight?: undefined | string; Default?: undefined | string; TopLeft?: undefined | string; TopRight?: undefined | string }

Represents the border radius of a container

see

{@link Rectangle.RoundingRadius}

Type declaration

  • Optional BottomLeft?: undefined | string

    Gets or sets a value in Length units indicating the bottom left border radius of a container

  • Optional BottomRight?: undefined | string

    Gets or sets a value in Length units indicating the bottom right border radius of a container

  • Optional Default?: undefined | string

    Gets or sets a value in Length units indicating the default border radius of a container

  • Optional TopLeft?: undefined | string

    Gets or sets a value in Length units indicating the top left border radius of a container

  • Optional TopRight?: undefined | string

    Gets or sets a value in Length units indicating the top right border radius of a container

Shape

Shape: { Bookmark?: undefined | string; Height?: undefined | string; Label?: undefined | string; Left?: undefined | string; Name: string; RoundingRadius?: RoundingRadius; ShapeStyle?: undefined | string; Style?: undefined | { BackgroundColor?: undefined | string; BackgroundImage?: BackgroundImage; Border?: BorderStyle; BottomBorder?: BorderStyle; LeftBorder?: BorderStyle; RightBorder?: BorderStyle; TopBorder?: BorderStyle }; ToolTip?: undefined | string; Top?: undefined | string; Type: "shape"; Visibility?: Visibility; Width?: undefined | string; ZIndex?: undefined | number }

Represents properties for a Shape in a report

Type declaration

  • Optional Bookmark?: undefined | string

    Gets or sets a value or an expression indicating the Id of a Shape for a Jump To Bookmark interactivity action.

  • Optional Height?: undefined | string

    Gets or sets a value in Length units indicating the height of a Shape

  • Optional Label?: undefined | string

    Gets or sets a value or an expression indicating the text associated with a Shape that appears in the Report Map and Table of Contents

  • Optional Left?: undefined | string

    Gets or sets a value in Length units indicating the distance of a Shape from the left of the shape's container

  • Name: string

    Gets or sets a unique identifier for a Shape

  • Optional RoundingRadius?: RoundingRadius

    Gets or sets a value indicating the shape's border radius.

    see

    RoundingRadius

  • Optional ShapeStyle?: undefined | string

    Gets or sets a value or an expression indicating the shape type The value or the expression result should be one of the following.

    value

    "Rectangle" indicates a rectangular shape

    value

    "RoundRect" indicates a rectangular shape with rounded corners

    value

    "Ellipse" indicates an ellipse

  • Optional Style?: undefined | { BackgroundColor?: undefined | string; BackgroundImage?: BackgroundImage; Border?: BorderStyle; BottomBorder?: BorderStyle; LeftBorder?: BorderStyle; RightBorder?: BorderStyle; TopBorder?: BorderStyle }

    Represents style information for a Shape

  • Optional ToolTip?: undefined | string

    Gets or sets a value or an expression indicating the text displayed when a report reader hovers over a Shape at preview time

  • Optional Top?: undefined | string

    Gets or sets a value in Length units indicating the distance of a Shape from the top of the shape's container

  • Type: "shape"

    Should be set to "shape"

  • Optional Visibility?: Visibility

    Gets or sets a value indicating whether a Shape is hidden

    see

    Visibility

  • Optional Width?: undefined | string

    Gets or sets a value in Length units indicating the width of a Shape

  • Optional ZIndex?: undefined | number

    Gets or sets a value indicating the stack order of a Shape

SortExpression

SortExpression: { Direction?: "Ascending" | "Descending"; Value?: undefined | string }

Represents an expression used in sorting

Type declaration

  • Optional Direction?: "Ascending" | "Descending"

    Gets or sets a value indicating the sort order.

    value

    "Ascending" indicates that the data is sorted in ascending order

    value

    "Descending" indicates that the data is sorted in descending order

    default

    "Ascending"

  • Optional Value?: undefined | string

    Gets or sets an expression that results in a data by which to order

Sparkline

Sparkline: { Bookmark?: undefined | string; DataSetName?: undefined | string; FillColor?: undefined | string; Filters?: Filter[]; GradientEndColor?: undefined | string; GradientStyle?: SparklineGradientStyle; Group?: Grouping; Height?: undefined | string; Label?: undefined | string; Left?: undefined | string; LineColor?: undefined | string; LineWidth?: undefined | string; MarkerColor?: undefined | string; MarkerVisibility?: undefined | false | true; MaximumColumnWidth?: undefined | string; Name: string; RangeFillColor?: undefined | string; RangeGradientEndColor?: undefined | string; RangeGradientStyle?: SparklineGradientStyle; RangeLowerBound?: undefined | string; RangeUpperBound?: undefined | string; RangeVisibility?: undefined | false | true; SeriesValue?: undefined | string; SortExpressions?: SortExpression[]; SparklineType?: "Line" | "Area" | "Columns" | "Whiskers" | "StackedBar"; ToolTip?: undefined | string; Top?: undefined | string; Type: "sparkline"; Visibility?: Visibility; Width?: undefined | string; ZIndex?: undefined | number }

Represents properties for a Sparkline

Type declaration

  • Optional Bookmark?: undefined | string

    Gets or sets a value or an expression indicating the Id of a Sparkline for a Jump To Bookmark interactivity action.

  • Optional DataSetName?: undefined | string

    Gets or sets the name of the dataset to use to bind data to a Sparkline.

  • Optional FillColor?: undefined | string

    Gets or sets expression that evaluates to the background color of geometrical shapes within a sparkline of "Area", "Columns", "Whiskers", and "Stacked Columns" types. The value or the expression result should be either a cross-browser color name or to a hexadecimal color code, such as #face0d.

  • Optional Filters?: Filter[]

    Gets or sets a value indicating a collection of filters to be applied to the data for each row of a Sparkline

    see

    Filter

  • Optional GradientEndColor?: undefined | string

    Gets ot sets a value or an expression indicating the end color for the background gradient of geometrical shapes within a sparkline of "Area", "Columns", "Whiskers", and "Stacked Columns" types. The value or the expression result should be a cross-browser color name or to a hexadecimal color code, such as #face0d.

  • Optional GradientStyle?: SparklineGradientStyle

    Gets ot sets a value indicating the type of background gradient of geometrical shapes within a sparkline.

    see

    SparklineGradientStyle

  • Optional Group?: Grouping

    Gets or sets a value indicating expressions by which to group the data in a Sparkline.

    see

    Grouping

  • Optional Height?: undefined | string

    Gets or sets a value in Length units indicating the height of a Sparkline.

  • Optional Label?: undefined | string

    Gets or sets a value or an expression indicating the text associated with a Sparkline that appears in the Report Map and Table of Contents

  • Optional Left?: undefined | string

    Gets or sets a value in Length units indicating the distance of a Sparkline from the left of the sparkline's container

  • Optional LineColor?: undefined | string

    Gets or sets expression that evaluates to the line color for a sparkline of "Line" type. The value or the expression result should be either a cross-browser color name or to a hexadecimal color code, such as #face0d.

  • Optional LineWidth?: undefined | string

    Gets or sets a value or an expression that evaluates to the line width for a sparkline of "Line" type. The value or the expression result should be in Length units

  • Optional MarkerColor?: undefined | string

    Gets or sets expression that evaluates to the foreground color of a marker at the last point of a sparkline of "Line" type. The value or the expression result should be either a cross-browser color name or to a hexadecimal color code, such as #face0d.

  • Optional MarkerVisibility?: undefined | false | true

    Gets or sets a value indicating whether to display a marker at the last point of a sparkline of Line type.

  • Optional MaximumColumnWidth?: undefined | string

    Gets or sets a value or an expression indicating the maximum width of columns for a sparkline of "Columns" and "Whiskers" types. The value or the expression result should be in Length units.

  • Name: string

    Gets or sets a unique identifier for a Sparkline

  • Optional RangeFillColor?: undefined | string

    Gets or sets expression that evaluates to the background color of the range within a sparkline. The value or the expression result should be either a cross-browser color name or to a hexadecimal color code, such as #face0d.

  • Optional RangeGradientEndColor?: undefined | string

    Gets ot sets a value or an expression indicating the end color for the background gradient of the range within a sparkline. The value or the expression result should be a cross-browser color name or to a hexadecimal color code, such as #face0d.

  • Optional RangeGradientStyle?: SparklineGradientStyle

    Gets ot sets a value indicating the type of background gradient of the range within a sparkline.

    see

    SparklineGradientStyle

  • Optional RangeLowerBound?: undefined | string

    Gets or sets a value or an expression indicating the lower bound of the range for a sparkline.

  • Optional RangeUpperBound?: undefined | string

    Gets or sets a value or an expression indicating the upper bound of the range for a sparkline.

  • Optional RangeVisibility?: undefined | false | true

    Gets or sets a value indicating whether to display a range of values for a sparkline.

  • Optional SeriesValue?: undefined | string

    Gets or sets an expression indicating the range of data values displayed in a sparkline.

  • Optional SortExpressions?: SortExpression[]

    Gets or sets a value indicating a collection of expressions by which to sort the data in a Sparkline.

    see

    SortExpression

  • Optional SparklineType?: "Line" | "Area" | "Columns" | "Whiskers" | "StackedBar"

    Gets or sets a value indicating the type of a Sparkline.

  • Optional ToolTip?: undefined | string

    Gets or sets a value or an expression indicating the text displayed when a report reader hovers over a Sparkline at preview time

  • Optional Top?: undefined | string

    Gets or sets a value in Length units indicating the distance of a Sparkline from the top of the sparkline's container

  • Type: "sparkline"

    Should be set to "sparkline"

  • Optional Visibility?: Visibility

    Gets or sets a value indicating whether a Sparkline is hidden

    see

    Visibility

  • Optional Width?: undefined | string

    Gets or sets a value in Length units indicating the width of a Sparkline.

  • Optional ZIndex?: undefined | number

    Gets or sets a value indicating the stack order of a Sparkline

SparklineGradientStyle

SparklineGradientStyle: "None" | "LeftRight" | "TopBottom" | "Center" | "DiagonalLeft" | "DiagonalRight" | "HorizontalCenter" | "VerticalCenter"

Represents the type of background gradient of a Sparkline.

Subreport

Subreport: { Bookmark?: undefined | string; Height?: undefined | string; KeepTogether?: undefined | false | true; Label?: undefined | string; Left?: undefined | string; Name: string; NoRowsMessage?: undefined | string; Parameters?: { Omit?: undefined | string; ParameterName?: undefined | string; Value?: undefined | string }[]; ReportName?: undefined | string; Style?: undefined | { Border?: BorderStyle; BottomBorder?: BorderStyle; Color?: undefined | string; Direction?: undefined | string; FontFamily?: undefined | string; FontSize?: undefined | string; FontStyle?: undefined | string; FontWeight?: undefined | string; Format?: undefined | string; Language?: undefined | string; LeftBorder?: BorderStyle; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string; RightBorder?: BorderStyle; TextAlign?: undefined | string; TextDecoration?: undefined | string; TopBorder?: BorderStyle; VerticalAlign?: undefined | string; WritingMode?: undefined | string }; ToolTip?: undefined | string; Top?: undefined | string; Type: "subreport"; Visibility?: Visibility; Width?: undefined | string; ZIndex?: undefined | number }

Represents properties for a Subreport in a report

Type declaration

  • Optional Bookmark?: undefined | string

    Gets or sets a value or an expression indicating the Id of a Subreport for a Jump To Bookmark interactivity action.

  • Optional Height?: undefined | string

    Gets or sets a value in Length units indicating the height of a Subreport

  • Optional KeepTogether?: undefined | false | true

    Gets or sets a value indicating whether the entire contents of a Subreport should be kept together on one Page if possible

  • Optional Label?: undefined | string

    Gets or sets a value or an expression indicating the text associated with a Subreport that appears in the Report Map and Table of Contents

  • Optional Left?: undefined | string

    Gets or sets a value in Length units indicating the distance of a Subreport from the left of the subreport's container

  • Name: string

    Gets or sets a unique identifier for a Subreport

  • Optional NoRowsMessage?: undefined | string

    Gets or sets a value or an expression indicating text to render instead of the subreport layout when no rows of data are available for a Subreport.

  • Optional Parameters?: { Omit?: undefined | string; ParameterName?: undefined | string; Value?: undefined | string }[]

    Gets or sets a value indicating the parameters to be evaluated and passed to the Subreport.

  • Optional ReportName?: undefined | string

    Gets or sets a value indicating either the location of the report definition to use for the Subreport or the Id to be resolved by the custom resource locator

  • Optional Style?: undefined | { Border?: BorderStyle; BottomBorder?: BorderStyle; Color?: undefined | string; Direction?: undefined | string; FontFamily?: undefined | string; FontSize?: undefined | string; FontStyle?: undefined | string; FontWeight?: undefined | string; Format?: undefined | string; Language?: undefined | string; LeftBorder?: BorderStyle; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string; RightBorder?: BorderStyle; TextAlign?: undefined | string; TextDecoration?: undefined | string; TopBorder?: BorderStyle; VerticalAlign?: undefined | string; WritingMode?: undefined | string }

    Represents style information for a Subreport

  • Optional ToolTip?: undefined | string

    Gets or sets a value or an expression indicating the text displayed when a report reader hovers over a Subreport at preview time

  • Optional Top?: undefined | string

    Gets or sets a value in Length units indicating the distance of a Subreport from the top of the subreport's container

  • Type: "subreport"

    Should be set to "subreport"

  • Optional Visibility?: Visibility

    Gets or sets a value indicating whether a Subreport is hidden

    see

    Visibility

  • Optional Width?: undefined | string

    Gets or sets a value in Length units indicating the width of a Subreport

  • Optional ZIndex?: undefined | number

    Gets or sets a value indicating the stack order of a Subreport

Table

Table: { Bookmark?: undefined | string; DataSetName?: undefined | string; Details?: TableDetails; Filters?: Filter[]; FixedHeight?: undefined | string; FixedWidth?: undefined | string; Footer?: TableFooter; Header?: TableHeader; Height?: undefined | string; KeepTogether?: undefined | false | true; Label?: undefined | string; Left?: undefined | string; Name: string; NewSection?: undefined | false | true; NoRowsMessage?: undefined | string; OverflowName?: undefined | string; PageBreak?: "None" | "Start" | "End" | "StartAndEnd" | "Between"; PreventOrphanedFooter?: undefined | false | true; RepeatToFill?: undefined | false | true; SortExpressions?: SortExpression[]; Style?: undefined | { BackgroundColor?: undefined | string; BackgroundImage?: BackgroundImage; Border?: BorderStyle; BottomBorder?: BorderStyle; Color?: undefined | string; Direction?: undefined | string; FontFamily?: undefined | string; FontSize?: undefined | string; FontStyle?: undefined | string; FontWeight?: undefined | string; Format?: undefined | string; Language?: undefined | string; LeftBorder?: BorderStyle; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string; RightBorder?: BorderStyle; TextAlign?: undefined | string; TextDecoration?: undefined | string; TopBorder?: BorderStyle; VerticalAlign?: undefined | string; WritingMode?: undefined | string }; TableColumns?: TableColumn[]; TableGroups?: TableGroup[]; ToolTip?: undefined | string; Top?: undefined | string; Type: "table"; Visibility?: Visibility; Width?: undefined | string; ZIndex?: undefined | number }

Represents properties for a Table in a report

Type declaration

  • Optional Bookmark?: undefined | string

    Gets or sets a value or an expression indicating the Id of a Table for a Jump To Bookmark interactivity action.

  • Optional DataSetName?: undefined | string

    Gets or sets the name of the dataset to use to bind data to a Table.

  • Optional Details?: TableDetails

    Gets or sets a value indicating the collection of detail rows for a Table.

  • Optional Filters?: Filter[]

    Gets or sets a value indicating a collection of filters to be applied to the data for each row of a Table

    see

    Filter

  • Optional FixedHeight?: undefined | string

    Gets or sets a value in Length units indicating the fixed height of a Table

  • Optional FixedWidth?: undefined | string

    Gets or sets a value in Length units indicating the fixed width of a Table

  • Optional Footer?: TableFooter

    Gets or sets a value indicating the collection of footer rows in a Table.

    see

    TableFooter

  • Optional Header?: TableHeader

    Gets or sets a value indicating the collection of header rows in a Table.

    see

    TableHeader

  • Optional Height?: undefined | string

    Gets or sets a value in Length units indicating the height of a Table

  • Optional KeepTogether?: undefined | false | true

    Gets or sets a value indicating whether the entire contents of a Table should be kept together on one Page if possible

  • Optional Label?: undefined | string

    Gets or sets a value or an expression indicating the text associated with a Table that appears in the Report Map and Table of Contents

  • Optional Left?: undefined | string

    Gets or sets a value in Length units indicating the distance of a Table from the left of the table's container

  • Name: string

    Gets or sets a unique identifier for a table

  • Optional NewSection?: undefined | false | true

    Gets or sets a value indicating a Table has its page numbering

  • Optional NoRowsMessage?: undefined | string

    Gets or sets a value or an expression indicating text to render instead of the list layout when no rows of data are available for a Table.

  • Optional OverflowName?: undefined | string

    Gets or sets a value indicating the name of the overflow place holder for a fixed Table layout

  • Optional PageBreak?: "None" | "Start" | "End" | "StartAndEnd" | "Between"

    Gets or sets a value indicating the location of a page breaks generated by a Table

  • Optional PreventOrphanedFooter?: undefined | false | true

    Gets or sets a value indicating whether a lonely table footer should be prevented.

  • Optional RepeatToFill?: undefined | false | true

    Gets or sets a value indicating whether a fixed table layout should fill the unused space with empty table rows

  • Optional SortExpressions?: SortExpression[]

    Gets or sets a value indicating a collection of expressions by which to sort repeated table rows

    see

    SortExpression

  • Optional Style?: undefined | { BackgroundColor?: undefined | string; BackgroundImage?: BackgroundImage; Border?: BorderStyle; BottomBorder?: BorderStyle; Color?: undefined | string; Direction?: undefined | string; FontFamily?: undefined | string; FontSize?: undefined | string; FontStyle?: undefined | string; FontWeight?: undefined | string; Format?: undefined | string; Language?: undefined | string; LeftBorder?: BorderStyle; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string; RightBorder?: BorderStyle; TextAlign?: undefined | string; TextDecoration?: undefined | string; TopBorder?: BorderStyle; VerticalAlign?: undefined | string; WritingMode?: undefined | string }

    Represents style information for a Table

  • Optional TableColumns?: TableColumn[]

    Gets or sets a value indicating the collection of columns in a Table.

    see

    TableColumn

  • Optional TableGroups?: TableGroup[]

    Gets or sets a value indicating the collection of table groups consisting of group expressions, group headers, and group footers for a table.

  • Optional ToolTip?: undefined | string

    Gets or sets a value or an expression indicating the text displayed when a report reader hovers over a Table at preview time

  • Optional Top?: undefined | string

    Gets or sets a value in Length units indicating the distance of a Table from the top of the table's container

  • Type: "table"

    Should be set to "table"

  • Optional Visibility?: Visibility

    Gets or sets a value indicating whether a Table is hidden

    see

    Visibility

  • Optional Width?: undefined | string

    Gets or sets a value in Length units indicating the width of a Table

  • Optional ZIndex?: undefined | number

    Gets or sets a value indicating the stack order of a Table

TableCell

TableCell: { ColSpan?: undefined | number; Item: ReportItem; RowSpan?: undefined | number }

Represents the contents of a cell in a Table.

see

Table

Type declaration

  • Optional ColSpan?: undefined | number

    Gets or sets a value indicating the number of columns that the cell spans.

  • Item: ReportItem

    Gets or sets a value indicating a report item that is contained within a cell of a Table

    see

    ReportItem

  • Optional RowSpan?: undefined | number

    Gets or sets a value indicating the number of rows that the cell spans.

TableColumn

TableColumn: { AutoWidth?: "None" | "Proportional"; Visibility?: Visibility; Width?: undefined | string }

Represents a column in a Table

see

Table

Type declaration

  • Optional AutoWidth?: "None" | "Proportional"
  • Optional Visibility?: Visibility

    Gets or sets a value indicating the presence of a column in a Table

    see

    Visibility

  • Optional Width?: undefined | string

    Gets or sets a value in Length units indicating the width of a column

TableDetails

TableDetails: { Group?: Grouping; SortExpressions?: SortExpression[]; TableRows?: TableRow[]; Visibility?: Visibility }

Represents the details rows for a Table

see

Table

Type declaration

  • Optional Group?: Grouping

    Gets or sets a value indicating the expressions by which to group the detail data in a Table.

    see

    Grouping

  • Optional SortExpressions?: SortExpression[]

    Gets or sets a value indicating a collection of expressions by which to sort detail data in a Table

    see

    SortExpression

  • Optional TableRows?: TableRow[]

    Gets or sets a value indicating a collection of the details rows for a Table

    see

    TableRow

  • Optional Visibility?: Visibility

    Gets or sets a value indicating the presence of the detail rows in a Table.

    see

    Visibility

TableFooter

TableFooter: { PrintAtBottom?: undefined | false | true; RepeatOnNewPage?: undefined | false | true; TableRows?: TableRow[] }

Represents the footer rows for a Table

see

Table

Type declaration

  • Optional PrintAtBottom?: undefined | false | true

    Gets or sets a value indicating whether a table footer always prints at the bottom of the page

  • Optional RepeatOnNewPage?: undefined | false | true

    Gets or sets a value indicating whether rendered footer rows are repeated on every Page where the header’s parent Table is rendered

  • Optional TableRows?: TableRow[]

    Gets or sets a value indicating a collection of the footer rows for a Table

    see

    TableRow

TableGroup

TableGroup: { Footer?: TableFooter; Group?: Grouping; Header?: TableHeader; KeepTogether?: undefined | false | true; PreventOrphanedFooter?: undefined | false | true; SortExpressions?: SortExpression[]; Visibility?: Visibility }

Represents a group in a Table

see

Table

Type declaration

  • Optional Footer?: TableFooter

    Gets or sets a value indicating a footer for a TableGroup.

    see

    TableFooter

  • Optional Group?: Grouping

    Gets or sets a value indicating expressions by which to group the data in a TableGroup.

    see

    Grouping

  • Optional Header?: TableHeader

    Gets or sets a value indicating a header for a TableGroup.

    see

    TableHeader

  • Optional KeepTogether?: undefined | false | true

    Gets or sets a value indicating whether the entire contents of a TableGroup should be kept together on one Page if possible

  • Optional PreventOrphanedFooter?: undefined | false | true

    Gets or sets a value indicating whether a lonely TableGroup footer should be prevented.

  • Optional SortExpressions?: SortExpression[]

    Gets or sets a value indicating a collection of expressions by which to the data in a TableGroup

    see

    SortExpression

  • Optional Visibility?: Visibility

    Gets or sets a value indicating the presence of a TableGroup.

    see

    Visibility

TableHeader

TableHeader: { RepeatOnNewPage?: undefined | false | true; TableRows?: TableRow[] }

Represents the header rows for a Table

see

Table

Type declaration

  • Optional RepeatOnNewPage?: undefined | false | true

    Gets or sets a value indicating whether rendered header rows are repeated on every Page where the header’s parent Table is rendered

  • Optional TableRows?: TableRow[]

    Gets or sets a value indicating a collection of the header rows for a Table

    see

    TableRow

TableOfContents

TableOfContents: { Bookmark?: undefined | string; Height?: undefined | string; Left?: undefined | string; Levels?: TableOfContentsLevel[]; Name: string; PageBreak?: "None" | "Start" | "End" | "StartAndEnd" | "Between"; Style?: undefined | { BackgroundColor?: undefined | string; Border?: BorderStyle; BottomBorder?: BorderStyle; LeftBorder?: BorderStyle; MaxLevel?: undefined | string; RightBorder?: BorderStyle; TopBorder?: BorderStyle }; ToolTip?: undefined | string; Top?: undefined | string; Type: "tableofcontents"; Visibility?: Visibility; Width?: undefined | string; ZIndex?: undefined | number }

Represents properties for a Table of Contents in a report

Type declaration

  • Optional Bookmark?: undefined | string

    Gets or sets a value or an expression indicating the Id of a Table of Contents for a Jump To Bookmark interactivity action.

  • Optional Height?: undefined | string

    Gets or sets a value in Length units indicating the height of a Table of Contents

  • Optional Left?: undefined | string

    Gets or sets a value in Length units indicating the distance of a Table of Contents from the left of its container

  • Optional Levels?: TableOfContentsLevel[]

    Gets or sets a value indicating a collection of levels in the hierarchy of a Table of Contents

  • Name: string

    Gets or sets a unique identifier for a Table of Contents

  • Optional PageBreak?: "None" | "Start" | "End" | "StartAndEnd" | "Between"

    Gets or sets a value indicating the location of a page breaks generated by a Table of Contents

  • Optional Style?: undefined | { BackgroundColor?: undefined | string; Border?: BorderStyle; BottomBorder?: BorderStyle; LeftBorder?: BorderStyle; MaxLevel?: undefined | string; RightBorder?: BorderStyle; TopBorder?: BorderStyle }

    Represents style information for a Table of Contents

  • Optional ToolTip?: undefined | string

    Gets or sets a value or an expression indicating the text displayed when a report reader hovers over a Table of Contents at preview time

  • Optional Top?: undefined | string

    Gets or sets a value in Length units indicating the distance of a Table of Contents from the top of its container

  • Type: "tableofcontents"

    Should be set to "tableofcontents"

  • Optional Visibility?: Visibility

    Gets or sets a value indicating whether a Table of Contents is hidden

    see

    Visibility

  • Optional Width?: undefined | string

    Gets or sets a value in Length units indicating the width of a Table of Contents

  • Optional ZIndex?: undefined | number

    Gets or sets a value indicating the stack order of a Table of Contents

TableOfContentsLevel

TableOfContentsLevel: { DisplayFillCharacters?: undefined | false | true; DisplayPageNumber?: undefined | false | true; LevelName?: undefined | string; Style?: undefined | { BackgroundColor?: undefined | string; Color?: undefined | string; FontFamily?: undefined | string; FontSize?: undefined | string; FontStyle?: undefined | string; FontWeight?: undefined | string; LeadingChar?: undefined | string; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string; TextAlign?: undefined | string; TextDecoration?: undefined | string; TextIndent?: undefined | string } }

Represents a level of the hierarchy in a Table of Contents

see

TableOfContents

Type declaration

  • Optional DisplayFillCharacters?: undefined | false | true

    Gets or sets a value indicating whether a level should fill space between the text and the page number

  • Optional DisplayPageNumber?: undefined | false | true

    Gets or sets a value indicating whether a level should display the page number

  • Optional LevelName?: undefined | string

    Gets or sets a value indicating a unique identifier for a level in a Table of Contents.

  • Optional Style?: undefined | { BackgroundColor?: undefined | string; Color?: undefined | string; FontFamily?: undefined | string; FontSize?: undefined | string; FontStyle?: undefined | string; FontWeight?: undefined | string; LeadingChar?: undefined | string; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string; TextAlign?: undefined | string; TextDecoration?: undefined | string; TextIndent?: undefined | string }

    Represents style information for a level in a Table of Contents

TableRow

TableRow: { Height?: undefined | string; TableCells?: TableCell[]; Visibility?: Visibility }

Represents a row of cells in a table

see

Table

Type declaration

  • Optional Height?: undefined | string

    Gets or sets a value in Length units indicating the height of a row

  • Optional TableCells?: TableCell[]

    Gets or sets a value indicating the contents of a row in a Table.

    see

    TableCell

  • Optional Visibility?: Visibility

    Gets or sets a value indicating the presence of a row in a Table.

    see

    Visibility

Tablix

Tablix: { Body?: TablixBody; Bookmark?: undefined | string; ColumnHierarchy?: TablixHierarchy; Corner?: TablixCornerRow[]; DataSetName?: undefined | string; Filters?: Filter[]; FixedHeight?: undefined | string; FixedWidth?: undefined | string; GroupsBeforeRowHeaders?: undefined | number; Height?: undefined | string; KeepTogether?: undefined | false | true; Label?: undefined | string; LayoutDirection?: "LTR" | "RTL"; Left?: undefined | string; Name: string; NewSection?: undefined | false | true; NoRowsMessage?: undefined | string; OverflowName?: undefined | string; PageBreak?: "None" | "Start" | "End" | "StartAndEnd" | "Between"; RepeatColumnHeaders?: undefined | false | true; RepeatRowHeaders?: undefined | false | true; RowHierarchy?: TablixHierarchy; SortExpressions?: SortExpression[]; Style?: undefined | { BackgroundColor?: undefined | string; BackgroundImage?: BackgroundImage; Border?: BorderStyle; BottomBorder?: BorderStyle; Color?: undefined | string; Direction?: undefined | string; FontFamily?: undefined | string; FontSize?: undefined | string; FontStyle?: undefined | string; FontWeight?: undefined | string; Format?: undefined | string; Language?: undefined | string; LeftBorder?: BorderStyle; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string; RightBorder?: BorderStyle; TextAlign?: undefined | string; TextDecoration?: undefined | string; TopBorder?: BorderStyle; VerticalAlign?: undefined | string; WritingMode?: undefined | string }; ToolTip?: undefined | string; Top?: undefined | string; Type: "tablix"; Visibility?: Visibility; Width?: undefined | string; ZIndex?: undefined | number }

Represents properties for a Tablix in a report

Type declaration

  • Optional Body?: TablixBody

    Gets or sets a value indicating the body of a Tablix.

    see

    TablixBody

  • Optional Bookmark?: undefined | string

    Gets or sets a value or an expression indicating the Id of a Tablix for a Jump To Bookmark interactivity action.

  • Optional ColumnHierarchy?: TablixHierarchy

    Gets or sets a value indicating the column hierarchy of a Tablix.

    see

    TablixHierarchy

  • Optional Corner?: TablixCornerRow[]

    Gets or sets a value indicating the corner of a Tablix.

    see

    TablixCornerRow

  • Optional DataSetName?: undefined | string

    Gets or sets the name of the dataset to use to bind data to a Tablix.

  • Optional Filters?: Filter[]

    Gets or sets a value indicating a collection of filters to be applied to the data for each row of a Tablix

    see

    Filter

  • Optional FixedHeight?: undefined | string

    Gets or sets a value in Length units indicating the fixed height of a Tablix

  • Optional FixedWidth?: undefined | string

    Gets or sets a value in Length units indicating the fixed width of a Tablix

  • Optional GroupsBeforeRowHeaders?: undefined | number

    Gets or sets a value indicating the count of dynamic member columns of the first Tablix column group to render before the tablix row header.

  • Optional Height?: undefined | string

    Gets or sets a value in Length units indicating the height of a Tablix

  • Optional KeepTogether?: undefined | false | true

    Gets or sets a value indicating whether the entire contents of a Tablix should be kept together on one Page if possible

  • Optional Label?: undefined | string

    Gets or sets a value or an expression indicating the text associated with a Tablix that appears in the Report Map and Table of Contents

  • Optional LayoutDirection?: "LTR" | "RTL"

    Gets or sets a value indicating the layout direction of Tablix columns.

    value

    "LTR" indicates that Tablix columns are rendered starting at the left and progressing to the right.

    value

    "RTL" indicates that Tablix columns are rendered starting at the right and progressing to the left.

  • Optional Left?: undefined | string

    Gets or sets a value in Length units indicating the distance of a Tablix from the left of the tablix's container

  • Name: string

    Gets or sets a unique identifier for a Tablix

  • Optional NewSection?: undefined | false | true

    Gets or sets a value indicating a Tablix has its page numbering

  • Optional NoRowsMessage?: undefined | string

    Gets or sets a value or an expression indicating text to render instead of the tablix layout when no rows of data are available for a Tablix.

  • Optional OverflowName?: undefined | string

    Gets or sets a value indicating the name of the overflow place holder for a fixed Tablix layout.

  • Optional PageBreak?: "None" | "Start" | "End" | "StartAndEnd" | "Between"

    Gets or sets a value indicating the location of a page breaks generated by a Tablix

  • Optional RepeatColumnHeaders?: undefined | false | true

    Gets or sets a value indicating whether tablix column headers are repeated on each page where the column traverses a page break.

  • Optional RepeatRowHeaders?: undefined | false | true

    Gets or sets a value indicating whether Tablix row headers are repeated on each page where the row traverses a page break.

  • Optional RowHierarchy?: TablixHierarchy

    Gets or sets a value indicating the row hierarchy of a Tablix.

    see

    TablixHierarchy

  • Optional SortExpressions?: SortExpression[]

    Gets or sets a value indicating a collection of expressions that are applied to the filtered data of a Tablix to order the data.

    see

    SortExpression

  • Optional Style?: undefined | { BackgroundColor?: undefined | string; BackgroundImage?: BackgroundImage; Border?: BorderStyle; BottomBorder?: BorderStyle; Color?: undefined | string; Direction?: undefined | string; FontFamily?: undefined | string; FontSize?: undefined | string; FontStyle?: undefined | string; FontWeight?: undefined | string; Format?: undefined | string; Language?: undefined | string; LeftBorder?: BorderStyle; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string; RightBorder?: BorderStyle; TextAlign?: undefined | string; TextDecoration?: undefined | string; TopBorder?: BorderStyle; VerticalAlign?: undefined | string; WritingMode?: undefined | string }

    Represents style information for a Tablix

  • Optional ToolTip?: undefined | string

    Gets or sets a value or an expression indicating the text displayed when a report reader hovers over a Tablix at preview time

  • Optional Top?: undefined | string

    Gets or sets a value in Length units indicating the distance of a Tablix from the top of the tablix's container

  • Type: "tablix"

    Should be set to "tablix"

  • Optional Visibility?: Visibility

    Gets or sets a value indicating whether a Tablix is hidden

    see

    Visibility

  • Optional Width?: undefined | string

    Gets or sets a value in Length units indicating the width of a Tablix

  • Optional ZIndex?: undefined | number

    Gets or sets a value indicating the stack order of a Tablix

TablixBody

TablixBody: { Columns?: string[]; Rows?: TablixBodyRow[] }

Represents the rows and columns of a Tablix.

Type declaration

  • Optional Columns?: string[]

    Gets or sets a value indicating the widths of the columns of the body of a Tablix. The widths should be specified in Length units

  • Optional Rows?: TablixBodyRow[]

    Gets or sets a value indicating the rows of the body of a Tablix.

    see

    TablixBodyRow

TablixBodyCell

TablixBodyCell: { ColSpan?: undefined | number; Item?: ReportItem; RowSpan?: undefined | number }

Represents the content of a cell in the TablixBody.

see

TablixBody

Type declaration

  • Optional ColSpan?: undefined | number

    Gets or sets a value indicating the number of columns that the cell spans.

  • Optional Item?: ReportItem

    Gets or sets a value indicating a report item that is contained within a cell of a TablixBody.

    see

    ReportItem

  • Optional RowSpan?: undefined | number

    Gets or sets a value indicating the number of rows that the cell spans.

TablixBodyRow

TablixBodyRow: { Cells?: TablixBodyCell[]; Height?: undefined | string }

Represents a collection of cells that form the TablixBody.

see

TablixBody

Type declaration

  • Optional Cells?: TablixBodyCell[]

    Gets or sets a value indicating a collection of cells of a row in the body of a Tablix.

    see

    TablixBodyCell

  • Optional Height?: undefined | string

    Gets or sets a value in Length units indicating the height of a row in a Tablix

TablixCornerCell

TablixCornerCell: { ColSpan?: undefined | number; Item?: ReportItem; RowSpan?: undefined | number }

Represents the content of a cell in the TabliCorner.

see

TablixCornerRow

Type declaration

  • Optional ColSpan?: undefined | number

    Gets or sets a value indicating the number of columns that the cell spans.

  • Optional Item?: ReportItem

    Gets or sets a value indicating a report item that is contained within a cell of a TablixCorner.

    see

    ReportItem

  • Optional RowSpan?: undefined | number

    Gets or sets a value indicating the number of rows that the cell spans.

TablixCornerRow

TablixCornerRow: TablixCornerCell[]

Represents a row in a TablixCorner

TablixGrouping

TablixGrouping: { DocumentMapLabel?: undefined | string; Filters?: Filter[]; GroupExpressions?: string[]; Name?: undefined | string; NewSection?: undefined | false | true; PageBreak?: "None" | "Start" | "End" | "StartAndEnd" | "Between"; PageBreakDisabled?: undefined | string; ParentGroup?: undefined | string; PrintFooterAtBottom?: undefined | false | true }

Represents expressions by which to categorize data and properties of the resulting data categorization in a Tablix

Type declaration

  • Optional DocumentMapLabel?: undefined | string

    Gets or sets a value or an expression indicating the text associated with a Tablix Group instance that appears in the Report Map and Table of Contents

  • Optional Filters?: Filter[]

    Gets or sets a value indicating a collection of filters for a Tablix Group.

    see

    Filter

  • Optional GroupExpressions?: string[]

    Gets or sets a value indicating a collection of expressions of a Tablix Group.

  • Optional Name?: undefined | string

    Gets or sets a value indicating a unique identifier for a TablixGrouping.

  • Optional NewSection?: undefined | false | true

    Gets or sets a value indicating a Tablix Member has its page numbering

  • Optional PageBreak?: "None" | "Start" | "End" | "StartAndEnd" | "Between"

    Gets or sets a value indicating the location of a page breaks generated by a Tablix Group.

  • Optional PageBreakDisabled?: undefined | string

    Gets or sets a value or an expression indicating whether the generated page break should be disabled. The value or the expression result should be either "true" or "false"

  • Optional ParentGroup?: undefined | string

    Gets or sets a value indicating an Id of a parent group

  • Optional PrintFooterAtBottom?: undefined | false | true

    Gets or sets a value indicating whether a group footer always prints at the bottom of the page

TablixHeader

TablixHeader: { Item?: ReportItem }

Represents contents in a tablix column group area or row group area.

Type declaration

  • Optional Item?: ReportItem

    Gets or sets a value indicating a report item that is contained within a TablixHeader

    see

    ReportItem

TablixHierarchy

TablixHierarchy: { Members?: TablixMember[] }

Represents the hierarchy of TablixMembers for a Tablix.

see

TablixMember

Type declaration

  • Optional Members?: TablixMember[]

    Gets or sets a value indicating members of a TablixHierarchy.

TablixMember

TablixMember: { BodyCount?: undefined | number; BodyIndex?: undefined | number; Group?: TablixGrouping; Header?: TablixHeader; KeepTogether?: undefined | false | true; KeepWithGroup?: "None" | "Before" | "After"; RepeatOnNewPage?: undefined | false | true; SortExpressions?: SortExpression[]; Visibility?: Visibility } & { Children?: TablixMember[] }

Represents the structure of an item in a Tablix hierarchy.

Textbox

Textbox: { Action?: Action; Bookmark?: undefined | string; CanGrow?: undefined | false | true; CanShrink?: undefined | false | true; Height?: undefined | string; KeepTogether?: undefined | false | true; Label?: undefined | string; Left?: undefined | string; Name: string; Style?: undefined | { Angle?: undefined | string; BackgroundColor?: undefined | string; BackgroundImage?: BackgroundImage; Border?: BorderStyle; BottomBorder?: BorderStyle; CharacterSpacing?: undefined | string; Color?: undefined | string; Direction?: undefined | string; FontFamily?: undefined | string; FontSize?: undefined | string; FontStyle?: undefined | string; FontWeight?: undefined | string; Format?: undefined | string; HeadingLevel?: undefined | string; Language?: undefined | string; LeftBorder?: BorderStyle; LineSpacing?: undefined | string; MinCondenseRate?: undefined | string; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string; RightBorder?: BorderStyle; ShrinkToFit?: undefined | string; TextAlign?: undefined | string; TextDecoration?: undefined | string; TextJustify?: "Auto" | "Distribute" | "DistributeAllLines"; TopBorder?: BorderStyle; VerticalAlign?: undefined | string; WrapMode?: undefined | string; WritingMode?: undefined | string }; ToggleImage?: undefined | { InitialState: string }; ToolTip?: undefined | string; Top?: undefined | string; Type: "textbox"; UserSort?: UserSort; Value?: undefined | string; Visibility?: Visibility; Width?: undefined | string; ZIndex?: undefined | number }

Represents properties for a Textbox in a report

Type declaration

  • Optional Action?: Action

    Gets or sets an action (such as a hyperlink) associated with a Textbox

    see

    Action

  • Optional Bookmark?: undefined | string

    Gets or sets a value or an expression indicating the Id of a textbox for a Jump To Bookmark interactivity action.

  • Optional CanGrow?: undefined | false | true

    Gets or sets a value indicating whether the height of a Textbox can increase to accommodate its contents

  • Optional CanShrink?: undefined | false | true

    Gets or sets a value indicating whether the height of a Textbox can decrease to match its contents

  • Optional Height?: undefined | string

    Gets or sets a value in Length units indicating the height of a Textbox

  • Optional KeepTogether?: undefined | false | true

    Gets or sets a value indicating whether the entire contents of a Textbox should be kept together on one Page if possible

  • Optional Label?: undefined | string

    Gets or sets a value or an expression indicating the text associated with a textbox that appears in the Report Map and Table of Contents

  • Optional Left?: undefined | string

    Gets or sets a value in Length units indicating the distance of a Textbox from the left of the text box's container

  • Name: string

    Gets or sets a unique identifier for a Textbox

  • Optional Style?: undefined | { Angle?: undefined | string; BackgroundColor?: undefined | string; BackgroundImage?: BackgroundImage; Border?: BorderStyle; BottomBorder?: BorderStyle; CharacterSpacing?: undefined | string; Color?: undefined | string; Direction?: undefined | string; FontFamily?: undefined | string; FontSize?: undefined | string; FontStyle?: undefined | string; FontWeight?: undefined | string; Format?: undefined | string; HeadingLevel?: undefined | string; Language?: undefined | string; LeftBorder?: BorderStyle; LineSpacing?: undefined | string; MinCondenseRate?: undefined | string; PaddingBottom?: undefined | string; PaddingLeft?: undefined | string; PaddingRight?: undefined | string; PaddingTop?: undefined | string; RightBorder?: BorderStyle; ShrinkToFit?: undefined | string; TextAlign?: undefined | string; TextDecoration?: undefined | string; TextJustify?: "Auto" | "Distribute" | "DistributeAllLines"; TopBorder?: BorderStyle; VerticalAlign?: undefined | string; WrapMode?: undefined | string; WritingMode?: undefined | string }

    Represents style information for a Textbox

  • Optional ToggleImage?: undefined | { InitialState: string }

    Represents the initial state (+/-) of a toggle image if it is displayed as part of a Textbox

  • Optional ToolTip?: undefined | string

    Gets or sets a value or an expression indicating the text displayed when a report reader hovers over a textbox at preview time

  • Optional Top?: undefined | string

    Gets or sets a value in Length units indicating the distance of a Textbox from the top of the text box's container

  • Type: "textbox"

    Should be set to "textbox"

  • Optional UserSort?: UserSort

    Gets or sets an end-user sort configuration that is displayed as part of a Textbox within the UI.

    see

    UserSort

  • Optional Value?: undefined | string

    Gets or sets a value or an expression that is displayed for a Textbox

  • Optional Visibility?: Visibility

    Gets or sets a value indicating whether a Textbox is hidden

    see

    Visibility

  • Optional Width?: undefined | string

    Gets or sets a value in Length units indicating the width of a Textbox

  • Optional ZIndex?: undefined | number

    Gets or sets a value indicating the stack order of a textbox

UserSort

UserSort: { SortExpression: string; SortExpressionScope?: undefined | string; SortTarget?: undefined | string }

Represents information about an end-user sort control that is displayed as part of a Textbox in a rendering of a Report

Type declaration

  • SortExpression: string

    Gets or sets an expression on which to sort

  • Optional SortExpressionScope?: undefined | string

    Gets or sets the name of the scope (data region or Group) in which to evaluate the SortExpression.

  • Optional SortTarget?: undefined | string

    Gets or sets the name of a data region, Group, or DataSet to which to apply the sort

    see

    Grouping

    see

    DataSet

ValidValues

ValidValues: { DataSetReference?: DataSetReference; ParameterValues?: ParameterValue[] }

Represents possible values for a report parameter and for populating UI selection lists for users to select a parameter value

see

{@link ReportParameter.ValidValues}

Type declaration

  • Optional DataSetReference?: DataSetReference

    Gets or sets the fields from a dataset to use to obtain a list of values and, optionally, labels for use in value validation and for populating the UI for the report parameter

    see

    {@link @DataSetReference}

  • Optional ParameterValues?: ParameterValue[]

    Get or sets the list of values and, optionally, labels for use in value validation and for populating the UI for the report parameter

    see

    ParameterValue

Visibility

Visibility: { Hidden?: undefined | string; ToggleItem?: undefined | string }

Represents properties to determine whether a report item is displayes in a rendered report.

Type declaration

  • Optional Hidden?: undefined | string

    Gets or sets an expression indicating whether a report item is initially hidden

  • Optional ToggleItem?: undefined | string

    Gets or sets the name of a Textbox that is used to hide or unhide the containing report item