Class BandScale

Hierarchy

DomainRangeScale<string[], [number, number], Dimension>
- BandScale

Index

Constructors

constructor

new BandScale(): BandScale

Inherited from DomainRangeScale< string[], [number, number], Dimension >.constructor
Returns BandScale

Properties

Protected Optional bindDomainValue

bindDomainValue?: string

Protected Optional bindRangeValue

bindRangeValue?: Dimension

Protected Optional domainValue

domainValue?: DomainCreator<string[]>

Protected Optional nameValue

nameValue?: string

Protected Optional rangeValue

rangeValue?: (args: ScaleCreationContext) => [number, number]

Type declaration

- (args: ScaleCreationContext): [number, number]
- Parameters
  - args: ScaleCreationContext
  Returns [number, number]

Protected Optional reverseValue

reverseValue?: boolean

Accessors

Protected bindDomainArray

get bindDomainArray(): string[]

- Defined in DomainScale.ts:94
Returns string[]

Protected defaultDomain

get defaultDomain(): Domain

- Defined in DomainScale.ts:57
Gets the default domain to use

Returns Domain

Protected defaultRange

get defaultRange(): Range

- Defined in DomainRangeScale.ts:60
Returns Range

Methods

align

align(value?: number): BandScale

- Defined in discrete/BandScale.ts:90
Bin alignment 0-beginning, 1=end

Parameters
- Optional value: number
Returns BandScale

bandwidthName

bandwidthName(value?: string): BandScale

- Defined in discrete/BandScale.ts:58
The name of the band-width static scale

Parameters
- Optional value: string
Returns BandScale

build

build(arg: ScaleCreationContext): Scales

Inherited from DomainRangeScale.build
- Defined in DomainScale.ts:45
Parameters
- arg: ScaleCreationContext
Returns Scales

Protected createScale

createScale(args: ScaleCreationContext): Scales

Overrides DomainRangeScale.createScale
- Defined in discrete/BandScale.ts:100
Parameters
- args: ScaleCreationContext
Returns Scales

domain

domain(arg?: string | string[] | DomainCreator<string[]>): BandScale

Inherited from DomainRangeScale.domain
- Defined in DomainScale.ts:31
Sets the domain of the scale

Parameters
- Optional arg: string | string[] | DomainCreator<string[]>
  
  The domain argument
Returns BandScale

Protected getDomain

getDomain(args: ScaleCreationContext): string[]

Inherited from DomainRangeScale.getDomain
- Defined in DomainScale.ts:66
Parameters
- args: ScaleCreationContext
Returns string[]

Protected getRange

getRange(args: ScaleCreationContext): [number, number]

Inherited from DomainRangeScale.getRange
- Defined in DomainRangeScale.ts:49
Parameters
- args: ScaleCreationContext
Returns [number, number]

Protected handleRangeBind

handleRangeBind(args: ScaleCreationContext, rangeBind: Dimension): [number, number]

Overrides DomainRangeScale.handleRangeBind
- Defined in discrete/BandScale.ts:136
Parameters
- args: ScaleCreationContext
- rangeBind: Dimension
Returns [number, number]

name

name(value?: string): BandScale

Inherited from DomainRangeScale.name
- Defined in DomainScale.ts:22
Sets the name of the scale

Parameters
- Optional value: string
  
  The name of the scale
Returns BandScale

padding

padding(value?: number): BandScale

- Defined in discrete/BandScale.ts:66
The outer and inner padding value

Parameters
- Optional value: number
Returns BandScale

paddingInner

paddingInner(value?: number): BandScale

- Defined in discrete/BandScale.ts:74
The inner padding value

Parameters
- Optional value: number
Returns BandScale

paddingOuter

paddingOuter(value?: number): BandScale

- Defined in discrete/BandScale.ts:82
The outer padding value

Parameters
- Optional value: number
Returns BandScale

Protected processDomainValues

processDomainValues(values: any[]): string[]

Inherited from DomainRangeScale.processDomainValues
- Defined in DomainScale.ts:62
Parameters
- values: any[]
Returns string[]

range

range(arg?: Dimension | [number, number] | ((args: ScaleCreationContext) => [number, number])): BandScale

Inherited from DomainRangeScale.range
- Defined in DomainRangeScale.ts:19
Parameters
- Optional arg: Dimension | [number, number] | ((args: ScaleCreationContext) => [number, number])
Returns BandScale

reverse

reverse(reversed?: boolean): BandScale

Inherited from DomainRangeScale.reverse
- Defined in DomainRangeScale.ts:35
Parameters
- Optional reversed: boolean
Returns BandScale

Protected reverseRange

reverseRange(range: [number, number]): [number, number]

Inherited from DomainRangeScale.reverseRange
- Defined in DomainRangeScale.ts:55
Parameters
- range: [number, number]
Returns [number, number]

round

round(value?: boolean): BandScale

- Defined in discrete/BandScale.ts:95
Parameters
- Optional value: boolean
Returns BandScale