DonutChart class

Package:

@microsoft/teams.cards

Extends

Element

Constructors

DonutChart(IDonutChartData[])

Properties

colorSet	the name of the set of colors to use.
data	the data to display in the chart.
title	the title of the chart.
type

Inherited Properties

fallback	Describes what to do when an unknown item is encountered or the requires of this or any children can't be met.
grid.area	the area of a Layout.AreaGrid layout in which an element should be displayed.
height	Specifies the height of the element.
horizontalAlignment	controls how the element should be horizontally aligned.
id	A unique identifier associated with the item
isVisible	If false, this item will be removed from the visual tree.
lang	The locale associated with the element.
requires	A series of key/value pairs indicating features that the item requires with corresponding minimum version. When a feature is missing or of insufficient version, fallback is triggered.
separator	When true, draw a separating line at the top of the element.
spacing	Controls the amount of spacing between this element and the preceding element.
targetWidth	Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space.

Methods

addData(IDonutChartData[])
withColorSet(string)
withOptions(DonutChartOptions)
withTitle(string)

Inherited Methods

withFallback(Element$1 | "drop" | Omit<string, "drop">)
withGridArea(string)
withHeight("auto" | "stretch" | Omit<string | number, "auto" | "stretch">)
withHorizontalAlignment(HorizontalAlignment)
withId(string)
withIsVisible(boolean)
withLang(string)
withRequire(string, string)
withRequires(Record<string, string>)
withSeperator(boolean)
withSpacing(Spacing)
withTargetWidth(TargetWidth)

Constructor Details

DonutChart(IDonutChartData[])

new DonutChart(data: IDonutChartData[])

Parameters

data

IDonutChartData[]

Property Details

colorSet

the name of the set of colors to use.

colorSet?: string

Property Value

string

data

the data to display in the chart.

data: IDonutChartData[]

Property Value

IDonutChartData[]

title

the title of the chart.

title?: string

Property Value

string

type

type: "Chart.Donut"

Property Value

"Chart.Donut"

Inherited Property Details

fallback

Describes what to do when an unknown item is encountered or the requires of this or any children can't be met.

fallback?: Element$1 | "drop" | Omit<string, "drop">

Property Value

Element | "drop" | Omit<string, "drop">

Inherited From Element.fallback

grid.area

the area of a Layout.AreaGrid layout in which an element should be displayed.

grid.area?: string

Property Value

string

Inherited From Element.grid.area

height

Specifies the height of the element.

height?: "auto" | "stretch" | Omit<string | number, "auto" | "stretch">

Property Value

"auto" | "stretch" | Omit<string | number, "auto" | "stretch">

Inherited From Element.height

horizontalAlignment

controls how the element should be horizontally aligned.

horizontalAlignment?: null | HorizontalAlignment

Property Value

null | HorizontalAlignment

Inherited From Element.horizontalAlignment

id

A unique identifier associated with the item

id?: string

Property Value

string

Inherited From Element.id

isVisible

If false, this item will be removed from the visual tree.

isVisible?: boolean

Property Value

boolean

Inherited From Element.isVisible

lang

The locale associated with the element.

lang?: string

Property Value

string

Inherited From Element.lang

requires

A series of key/value pairs indicating features that the item requires with corresponding minimum version. When a feature is missing or of insufficient version, fallback is triggered.

requires?: Record<string, string>

Property Value

Record<string, string>

Inherited From Element.requires

separator

When true, draw a separating line at the top of the element.

separator?: boolean

Property Value

boolean

Inherited From Element.separator

spacing

Controls the amount of spacing between this element and the preceding element.

spacing?: Spacing

Property Value

Spacing

Inherited From Element.spacing

targetWidth

Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space.

targetWidth?: TargetWidth

Property Value

TargetWidth

Inherited From Element.targetWidth

Method Details

addData(IDonutChartData[])

function addData(data: IDonutChartData[]): DonutChart

Parameters

data

IDonutChartData[]

Returns

DonutChart

withColorSet(string)

function withColorSet(value: string): DonutChart

Parameters

value

string

Returns

DonutChart

withOptions(DonutChartOptions)

function withOptions(value: DonutChartOptions): DonutChart

Parameters

value

DonutChartOptions

Returns

DonutChart

withTitle(string)

function withTitle(value: string): DonutChart

Parameters

value

string

Returns

DonutChart

Inherited Method Details

withFallback(Element$1 | "drop" | Omit<string, "drop">)

function withFallback(value: Element$1 | "drop" | Omit<string, "drop">): DonutChart

Parameters

value

Element | "drop" | Omit<string, "drop">

Returns

DonutChart

Inherited From Element.withFallback

withGridArea(string)

function withGridArea(value: string)

Parameters

value

string

Inherited From Element.withGridArea

withHeight("auto" | "stretch" | Omit<string | number, "auto" | "stretch">)

function withHeight(value: "auto" | "stretch" | Omit<string | number, "auto" | "stretch">): DonutChart

Parameters

value

"auto" | "stretch" | Omit<string | number, "auto" | "stretch">

Returns

DonutChart

Inherited From Element.withHeight

withHorizontalAlignment(HorizontalAlignment)

function withHorizontalAlignment(value: HorizontalAlignment): DonutChart

Parameters

value

HorizontalAlignment

Returns

DonutChart

Inherited From Element.withHorizontalAlignment

withId(string)

function withId(value: string): DonutChart

Parameters

value

string

Returns

DonutChart

Inherited From Element.withId

withIsVisible(boolean)

function withIsVisible(value: boolean): DonutChart

Parameters

value

boolean

Returns

DonutChart

Inherited From Element.withIsVisible

withLang(string)

function withLang(value: string): DonutChart

Parameters

value

string

Returns

DonutChart

Inherited From Element.withLang

withRequire(string, string)

function withRequire(key: string, value: string): DonutChart

Parameters

key

string

value

string

Returns

DonutChart

Inherited From Element.withRequire

withRequires(Record<string, string>)

function withRequires(value: Record<string, string>): DonutChart

Parameters

value

Record<string, string>

Returns

DonutChart

Inherited From Element.withRequires

withSeperator(boolean)

function withSeperator(value: boolean): DonutChart

Parameters

value

boolean

Returns

DonutChart

Inherited From Element.withSeperator

withSpacing(Spacing)

function withSpacing(value: Spacing): DonutChart

Parameters

value

Spacing

Returns

DonutChart

Inherited From Element.withSpacing

withTargetWidth(TargetWidth)

function withTargetWidth(value: TargetWidth): DonutChart

Parameters

value

TargetWidth

Returns

DonutChart

Inherited From Element.withTargetWidth