Class MeterTitle

Hierarchy (View Summary)

Title
- MeterTitle

Constructors

constructor

new MeterTitle(
    model: ChartModel,
    services: interfaces.Services,
    configs?: any,
): MeterTitle
Parameters
- model: ChartModel
- services: interfaces.Services
- Optionalconfigs: any
Returns MeterTitle
Inherited from Title.constructor
- Defined in packages/core/src/components/component.ts:25

Properties

`Protected`configs

configs: any = {}

id

id: string = ''

`Protected`model

model: ChartModel

`Protected`parent

parent: Selection<SVGGraphicsElement | HTMLDivElement, any, HTMLElement, any> = undefined

renderType

renderType: interfaces.RenderTypes = RenderTypes.SVG

`Protected`services

services: interfaces.Services

type

type: string = 'meter-title'

Methods

appendPercentage

appendPercentage(): void
Appends the associated percentage to the end of the title

Returns void
- Defined in packages/core/src/components/essentials/title-meter.ts:208

destroy

destroy(): void
Returns void
Inherited from Title.destroy
- Defined in packages/core/src/components/component.ts:58

displayBreakdownTitle

displayBreakdownTitle(): void
Returns void
- Defined in packages/core/src/components/essentials/title-meter.ts:61

displayStatus

displayStatus(): void
Appends the corresponding status based on the value and the peak.

Returns void
- Defined in packages/core/src/components/essentials/title-meter.ts:159

displayTotal

displayTotal(): void
Returns void
- Defined in packages/core/src/components/essentials/title-meter.ts:111

getComponentContainer

getComponentContainer(
    configs?: {
        ariaLabel?: string;
        isPresentational?: boolean;
        withinChartClip?: boolean;
    },
): Selection<any, any, Element, any>
Parameters
- configs: { ariaLabel?: string; isPresentational?: boolean; withinChartClip?: boolean } = ...
Returns Selection<any, any, Element, any>
Inherited from Title.getComponentContainer
- Defined in packages/core/src/components/component.ts:94

`Protected`getMaxTitleWidth

getMaxTitleWidth(): number
Returns number
Overrides Title.getMaxTitleWidth
- Defined in packages/core/src/components/essentials/title-meter.ts:261

getOptions

getOptions(): any
graphs used in combo charts share a model with global options but can receive their own local options. this function retrieves the global options and merges it with any options passed into this component's config.options object.

Returns any
Inherited from Title.getOptions
- Defined in packages/core/src/components/component.ts:152

getParent

getParent(): Selection<
    SVGGraphicsElement
    | HTMLDivElement,
    any,
    HTMLElement,
    any,
>
Returns Selection<SVGGraphicsElement | HTMLDivElement, any, HTMLElement, any>
Inherited from Title.getParent
- Defined in packages/core/src/components/component.ts:90

`Protected`getStatusIconPathString

getStatusIconPathString(
    status: interfaces.Statuses,
):
    | "M6.875 11.3125 3.75 8.1875 4.74375 7.25 6.875 9.34375 11.50625 4.75 12.5 5.7375 Z"
    | "M10.7 11.5 4.5 5.3 5.3 4.5 11.5 10.7 Z"
    | "M7.9375,11.125 C7.41973305,11.125 7,11.544733 7,12.0625 C7,12.580267 7.41973305,13 7.9375,13 C8.45526695,13 8.875,12.580267 8.875,12.0625 C8.875,11.544733 8.45526695,11.125 7.9375,11.125 M7.3125, 3 8.5625, 3 8.5625, 9.875 7.3125, 9.875, 7.3125, 3 Z"
Get the associated status icon for the data
Parameters
- status: interfaces.Statuses
  the active status for the meter chart
Returns
    | "M6.875 11.3125 3.75 8.1875 4.74375 7.25 6.875 9.34375 11.50625 4.75 12.5 5.7375 Z"
    | "M10.7 11.5 4.5 5.3 5.3 4.5 11.5 10.7 Z"
    | "M7.9375,11.125 C7.41973305,11.125 7,11.544733 7,12.0625 C7,12.580267 7.41973305,13 7.9375,13 C8.45526695,13 8.875,12.580267 8.875,12.0625 C8.875,11.544733 8.45526695,11.125 7.9375,11.125 M7.3125, 3 8.5625, 3 8.5625, 9.875 7.3125, 9.875, 7.3125, 3 Z"
- Defined in packages/core/src/components/essentials/title-meter.ts:293

`Protected`getSubstringIndex

getSubstringIndex(title: any, start: number, end: number, width: number): number
Returns the index for a maximum length substring that is less than the width parameter.
Parameters
- title: any
  the title node used for getting the text lengths of substrings
- start: number
  the start index for the binary search
- end: number
  the end index for the binary search
- width: number
  the width of the svg container that holds the title
Returns number
Inherited from Title.getSubstringIndex
- Defined in packages/core/src/components/essentials/title.ts:131

init

init(): void
Returns void
Inherited from Title.init
- Defined in packages/core/src/components/component.ts:47

render

render(animate?: boolean): void
Parameters
- animate: boolean = false
Returns void
Overrides Title.render
- Defined in packages/core/src/components/essentials/title-meter.ts:16

setModel

setModel(newObj: any): void
Parameters
- newObj: any
Returns void
Inherited from Title.setModel
- Defined in packages/core/src/components/component.ts:63

setParent

setParent(parent: any): void
Parameters
- parent: any
Returns void
Inherited from Title.setParent
- Defined in packages/core/src/components/component.ts:72

setServices

setServices(newObj: any): void
Parameters
- newObj: any
Returns void
Inherited from Title.setServices
- Defined in packages/core/src/components/component.ts:68

truncateTitle

truncateTitle(title: any, maxWidth: number): void
Uses the parent class truncate logic
Parameters
- title: any
  d3 selection of title element that will be truncated
- maxWidth: number
  the max width the title can take
Returns void
Overrides Title.truncateTitle
- Defined in packages/core/src/components/essentials/title-meter.ts:245

Class MeterTitle

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MeterTitle

Properties

Protectedconfigs

id

Protectedmodel

Protectedparent

renderType

Protectedservices

type

Methods

appendPercentage

Returns void

destroy

Returns void

displayBreakdownTitle

Returns void

displayStatus

Returns void

displayTotal

Returns void

getComponentContainer

Parameters

Returns Selection<any, any, Element, any>

ProtectedgetMaxTitleWidth

Returns number

getOptions

Returns any

getParent

Returns Selection<SVGGraphicsElement | HTMLDivElement, any, HTMLElement, any>

ProtectedgetStatusIconPathString

Parameters

ProtectedgetSubstringIndex

Parameters

Returns number

init

Returns void

render

Parameters

Returns void

setModel

Parameters

Returns void

setParent

Parameters

Returns void

setServices

Parameters

Returns void

truncateTitle

Parameters

Returns void

Settings

On This Page

`Protected`configs

`Protected`model

`Protected`parent

`Protected`services

`Protected`getMaxTitleWidth

`Protected`getStatusIconPathString

`Protected`getSubstringIndex