StiDataBarsColumn

Hierarchy

StiMeasureColumn
- StiDataBarsColumn

Implements

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new StiDataBarsColumn(key?: string, expression?: string, label?: string, horAlignment?: StiHorAlignment, textFormat?: StiFormatService, visibility?: StiTableColumnVisibility, visibilityExpression?: string, foreColor?: Color, positiveColor?: Color, negativeColor?: Color, overlappedColor?: Color, fillColor?: Color, showTotalSummary?: boolean, summaryType?: StiSummaryColumnType, summaryAlignment?: StiHorAlignment, headerAlignment?: StiHorAlignment, width?: number, minimum?: string, maximum?: string): StiDataBarsColumn

Overrides StiMeasureColumn.constructor

Parameters
- Optional key: string
- Optional expression: string
- Optional label: string
- Optional horAlignment: StiHorAlignment
- Optional textFormat: StiFormatService
- Optional visibility: StiTableColumnVisibility
- Optional visibilityExpression: string
- Optional foreColor: Color
- Optional positiveColor: Color
- Optional negativeColor: Color
- Optional overlappedColor: Color
- Optional fillColor: Color
- Optional showTotalSummary: boolean
- Optional summaryType: StiSummaryColumnType
- Optional summaryAlignment: StiHorAlignment
- Optional headerAlignment: StiHorAlignment
- Optional width: number
- Optional minimum: string
- Optional maximum: string
Returns StiDataBarsColumn

Properties

Protected _hash

_hash: StiMeta[]

dashboardInteraction

dashboardInteraction: IStiDashboardInteraction = new StiTableColumnDashboardInteraction()

expression

expression: string = ""

fillColor

fillColor: Color = Color.transparent

Gets or sets a color for drawing data bar of positive values.

foreColor

foreColor: Color = Color.transparent

Gets or sets font color for this element.

headerAlignment

headerAlignment: StiHorAlignment = StiHorAlignment.Center

The horizontal alignment of the header that will be displayed on the component.

horAlignment

horAlignment: StiHorAlignment = StiHorAlignment.Left

Gets or sets a text horizontal alignment.

ident

ident: StiMeterIdent = StiMeterIdent.DataBarsColumn

ID code of this meter. Used in JSON saving.

key

key: string

Gets or sets unically object identificator.

label

label: string = ""

maximum

maximum: string = ""

Gets or sets an expression for the possible maximum value of the databar column.

minimum

minimum: string = ""

Gets or sets an expression for the possible minimum value of the databar column.

negativeColor

negativeColor: Color = Color.transparent

Gets or sets a color for drawing data bar of positive values.

overlappedColor

overlappedColor: Color = Color.transparent

Gets or sets a color for drawing data bar of positive values.

positiveColor

positiveColor: Color = Color.transparent

Gets or sets a color for drawing data bar of positive values.

showTotalSummary

showTotalSummary: boolean = false

Gets or sets a visibility of column totals.

summaryAlignment

summaryAlignment: StiHorAlignment = StiHorAlignment.Right

Gets or sets a summary type of column totals.

summaryType

summaryType: StiSummaryColumnType = StiSummaryColumnType.Sum

Gets or sets a summary type of column totals.

textFormat

textFormat: StiFormatService = new StiGeneralFormatService()

Gets or sets the format of the text.

visibility

visibility: StiTableColumnVisibility = StiTableColumnVisibility.True

Gets or sets a visibility of a column.

visibilityExpression

visibilityExpression: string = null

Gets or sets an expression of the visibility.

width

width: number = 0

Gets or sets a width of this column.

Accessors

localizedName

get localizedName(): string

Overrides StiMeasureColumn.localizedName

Localized name of this component type.

Returns string

visible

get visible(): boolean
set visible(value: boolean): void

Inherited from StiTableColumn.visible

Gets or sets a visibility of the column.

Returns boolean
Inherited from StiTableColumn.visible

Gets or sets a visibility of the column.

Parameters
- value: boolean
Returns void

Methods

as

as<T>(type: object | Interface<T>): T

Inherited from StiCardsColumn.as

Type parameters
- T
Parameters
- type: object | Interface<T>
Returns T

clone

clone(): any

Inherited from StiTableColumn.clone

Overrides StiMeter.clone

Creates a new object that is a copy of the current instance.

Returns any

A new object that is a copy of this instance.

getDataFormat

getDataFormat(): StiDataFormatKind

Implementation of IStiDataFormat.getDataFormat

Inherited from StiTableColumn.getDataFormat

Returns StiDataFormatKind

getUniqueCode

getUniqueCode(): number

Implementation of IStiMeasureMeter.getUniqueCode

Overrides StiTableColumn.getUniqueCode

Returns number

implements

implements(): any[]

Overrides StiMeasureColumn.implements

Returns any[]

is

is<T>(type: object | Interface<T>): this

Inherited from StiCardsColumn.is

Type parameters
- T
Parameters
- type: object | Interface<T>
Returns this

is2

is2<T>(type: object | Interface<T>): boolean

Inherited from StiCardsColumn.is2

Type parameters
- T
Parameters
- type: object | Interface<T>
Returns boolean

isDefault

isDefault(): boolean

Inherited from StiCardsColumn.isDefault

Returns boolean

loadFromJsonObject

loadFromJsonObject(j: StiJson): void

Implementation of IStiJsonReportObject.loadFromJsonObject

Inherited from StiCardsColumn.loadFromJsonObject

Parameters
- j: StiJson
Returns void

loadFromString

loadFromString(str: string): void

Inherited from StiCardsColumn.loadFromString

Parameters
- str: string
Returns void

loadFromXml

loadFromXml(xn: XmlNode): void

Inherited from StiCardsColumn.loadFromXml

Parameters
- xn: XmlNode
Returns void

saveToJsonObject

saveToJsonObject(mode: StiJsonSaveMode): StiJson

Implementation of IStiJsonReportObject.saveToJsonObject

Inherited from StiCardsColumn.saveToJsonObject

Parameters
- mode: StiJsonSaveMode
Returns StiJson

saveToString

saveToString(): string

Inherited from StiCardsColumn.saveToString

Returns string

toString

toString(): string

Inherited from StiCardsColumn.toString

Returns string

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional key: string

Optional expression: string

Optional label: string

Optional horAlignment: StiHorAlignment

Optional textFormat: StiFormatService

Optional visibility: StiTableColumnVisibility

Optional visibilityExpression: string

Optional foreColor: Color

Optional positiveColor: Color

Optional negativeColor: Color

Optional overlappedColor: Color

Optional fillColor: Color

Optional showTotalSummary: boolean

Optional summaryType: StiSummaryColumnType

Optional summaryAlignment: StiHorAlignment

Optional headerAlignment: StiHorAlignment

Optional width: number

Optional minimum: string

Optional maximum: string

Returns StiDataBarsColumn

Properties

Protected _hash

dashboardInteraction

expression

fillColor

foreColor

headerAlignment

horAlignment

ident

key

label

maximum

minimum

negativeColor

overlappedColor

positiveColor

showTotalSummary

summaryAlignment

summaryType

textFormat

visibility

visibilityExpression

width

Accessors

localizedName

Returns string

visible

Returns boolean

Parameters

value: boolean

Returns void

Methods

as

Type parameters

T

Parameters

type: object | Interface<T>

Returns T

clone

Returns any

getDataFormat

Returns StiDataFormatKind

getUniqueCode

Returns number

implements

Returns any[]

is

Type parameters

T

Parameters