Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alrico88/scale-helper-functions

Helper to create scales
https://github.com/alrico88/scale-helper-functions

d3 dataset dataset-extent javascript linear log-scale node quantile-scale

Last synced: 23 days ago
JSON representation

Helper to create scales

Host: GitHub
URL: https://github.com/alrico88/scale-helper-functions
Owner: alrico88
Created: 2019-07-19T08:35:04.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-08-17T12:41:28.000Z (over 1 year ago)
Last Synced: 2024-12-09T05:39:52.198Z (27 days ago)
Topics: d3, dataset, dataset-extent, javascript, linear, log-scale, node, quantile-scale
Language: TypeScript
Homepage: https://www.npmjs.com/package/scale-helper-functions
Size: 1.54 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 11
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # scale-helper-functions

Compendium of helpers to create scales

## Installation

Using npm, `npm i scale-helper-functions`.

Using yarn, `yarn add scale-helper-functions`.

## Usage

Using `import`

```javascript

import {createLinearScale} from 'scale-helper-functions';

const domain = [0, 10];

const range = [0, 100];

const scale = createLinearScale(domain, range);

const transformed = scale(5); // transformed is 50

```

In a CommonJS environment

```javascript

const {createOrdinalScale} = require('scale-helper-functions');

const animals = ['cat', 'dog'];

const range = ['white', 'brown'];

const scale = createOrdinalScale(animals, range);

const color = scale('dog'); // color is brown

```

## Table of contents

### Type aliases

- [OrdinalScaleFunction](#ordinalscalefunction)

- [ScaleFunction](#scalefunction)

### Functions

- [createLinearInterpolator](#createlinearinterpolator)

- [createLinearScale](#createlinearscale)

- [createLogScale](#createlogscale)

- [createOpacityScale](#createopacityscale)

- [createOrdinalScale](#createordinalscale)

- [createQuantileScale](#createquantilescale)

- [createQuantizeScale](#createquantizescale)

- [getLinearDomainRange](#getlineardomainrange)

## Type aliases

### OrdinalScaleFunction

Ƭ **OrdinalScaleFunction**: (`s`: _string_) => _string_

#### Type declaration:

▸ (`s`: _string_): _string_

#### Parameters:

| Name | Type     |

| :--- | :------- |

| `s`  | _string_ |

**Returns:** _string_

Defined in: [modules/types.ts:3](https://github.com/alrico88/scale-helper-functions/blob/4978647/src/modules/types.ts#L3)

---

### ScaleFunction

Ƭ **ScaleFunction**: (`n`: _number_) => _number_ \| _string_

#### Type declaration:

▸ (`n`: _number_): _number_ \| _string_

#### Parameters:

| Name | Type     |

| :--- | :------- |

| `n`  | _number_ |

**Returns:** _number_ \| _string_

Defined in: [modules/types.ts:1](https://github.com/alrico88/scale-helper-functions/blob/4978647/src/modules/types.ts#L1)

## Functions

### createLinearInterpolator

▸ **createLinearInterpolator**(`domain`: _number_[]): [_ScaleFunction_](#scalefunction)

Function that given a domain, returns a scale that will trasform a number to a value between 0 and 1

#### Parameters:

| Name     | Type       |

| :------- | :--------- |

| `domain` | _number_[] |

**Returns:** [_ScaleFunction_](#scalefunction)

Defined in: [modules/interpolation.ts:9](https://github.com/alrico88/scale-helper-functions/blob/4978647/src/modules/interpolation.ts#L9)

---

### createLinearScale

▸ **createLinearScale**(`domain`: _number_[], `range`: Range): [_ScaleFunction_](#scalefunction)

Creates a linear scale

#### Parameters:

| Name     | Type       | Description                         |

| :------- | :--------- | :---------------------------------- |

| `domain` | _number_[] |                                     |

| `range`  | Range      | Desired resulting values of scaling |

**Returns:** [_ScaleFunction_](#scalefunction)

The scale function

Defined in: [modules/scales.ts:13](https://github.com/alrico88/scale-helper-functions/blob/4978647/src/modules/scales.ts#L13)

---

### createLogScale

▸ **createLogScale**(`domain`: _number_[], `range`: Range, `base?`: _number_): [_ScaleFunction_](#scalefunction)

Creates a log scale

#### Parameters:

| Name     | Type       | Description                         |

| :------- | :--------- | :---------------------------------- |

| `domain` | _number_[] |                                     |

| `range`  | Range      | Desired resulting values of scaling |

| `base?`  | _number_   | -                                   |

**Returns:** [_ScaleFunction_](#scalefunction)

The scale function

Defined in: [modules/scales.ts:25](https://github.com/alrico88/scale-helper-functions/blob/4978647/src/modules/scales.ts#L25)

---

### createOpacityScale

▸ **createOpacityScale**(`domain`: _number_[]): [_ScaleFunction_](#scalefunction)

Returns, given a domain, a function that will convert a number to another one between 0 and 255

Useful for calculating opacity values for RGBA strings

**`export`**

#### Parameters:

| Name     | Type       |

| :------- | :--------- |

| `domain` | _number_[] |

**Returns:** [_ScaleFunction_](#scalefunction)

The scale function

Defined in: [modules/scales.ts:77](https://github.com/alrico88/scale-helper-functions/blob/4978647/src/modules/scales.ts#L77)

---

### createOrdinalScale

▸ **createOrdinalScale**(`domain`: _string_[], `range`: _string_[]): [_OrdinalScaleFunction_](#ordinalscalefunction)

Returns an ordinal scale

Discrete input and discrete output

#### Parameters:

| Name     | Type       | Description                             |

| :------- | :--------- | :-------------------------------------- |

| `domain` | _string_[] | Discrete list of values ['A', 'B', 'C'] |

| `range`  | _string_[] | Desired resulting values of scaling     |

**Returns:** [_OrdinalScaleFunction_](#ordinalscalefunction)

The scale function

Defined in: [modules/scales.ts:65](https://github.com/alrico88/scale-helper-functions/blob/4978647/src/modules/scales.ts#L65)

---

### createQuantileScale

▸ **createQuantileScale**(`dataset`: _number_[], `range`: Range): [_ScaleFunction_](#scalefunction)

Returns a quantile scale based on dataset

Maps continuous numeric input to discrete values. The domain is defined by an array of numbers:

#### Parameters:

| Name      | Type       | Description                         |

| :-------- | :--------- | :---------------------------------- |

| `dataset` | _number_[] | Full dataset to take into account   |

| `range`   | Range      | Desired resulting values of scaling |

**Returns:** [_ScaleFunction_](#scalefunction)

The scale function

Defined in: [modules/scales.ts:41](https://github.com/alrico88/scale-helper-functions/blob/4978647/src/modules/scales.ts#L41)

---

### createQuantizeScale

▸ **createQuantizeScale**(`domain`: _number_[], `range`: Range): [_ScaleFunction_](#scalefunction)

Returns a quantized scale based on dataset extent

Accepts continuous input and outputs a number of discrete quantities defined by the range.

#### Parameters:

| Name     | Type       | Description                         |

| :------- | :--------- | :---------------------------------- |

| `domain` | _number_[] |                                     |

| `range`  | Range      | Desired resulting values of scaling |

**Returns:** [_ScaleFunction_](#scalefunction)

The scale function

Defined in: [modules/scales.ts:53](https://github.com/alrico88/scale-helper-functions/blob/4978647/src/modules/scales.ts#L53)

---

### getLinearDomainRange

▸ **getLinearDomainRange**(`domain`: _number_[], `segmentsAmount`: _number_): _number_[]

Gets a domain of N elements from a domain with less length

**`export`**

#### Parameters:

| Name             | Type       | Description                              |

| :--------------- | :--------- | :--------------------------------------- |

| `domain`         | _number_[] | The existing domain                      |

| `segmentsAmount` | _number_   | The desired length for the linear domain |

**Returns:** _number_[]

The resulting domain

Defined in: [modules/helpers.ts:9](https://github.com/alrico88/scale-helper-functions/blob/4978647/src/modules/helpers.ts#L9)