Class: PageParam<V>#
Renderer.Navigation.PageParam
Type parameters#
| Name | Type |
|---|---|
V |
any |
Table of contents#
Constructors#
Properties#
Accessors#
Methods#
Constructors#
constructor#
• new PageParam<V>(init, history)
Type parameters#
| Name | Type |
|---|---|
V |
any |
Parameters#
| Name | Type |
|---|---|
init |
PageParamInit<V> |
history |
ObservableHistory<Object> |
Properties#
isMulti#
• Readonly isMulti: boolean
name#
• Readonly name: string
Accessors#
defaultValue#
• get defaultValue(): V
Returns#
V
Methods#
clear#
▸ clear(): void
Returns#
void
get#
▸ get(): V
Returns#
V
getRaw#
▸ getRaw(): string | string[]
Get stringified raw value(s) from document.location.search
Returns#
string | string[]
parse#
▸ parse(values): V
Parameters#
| Name | Type |
|---|---|
values |
string | string[] |
Returns#
V
set#
▸ set(value, __namedParameters?): void
Parameters#
| Name | Type |
|---|---|
value |
V |
__namedParameters |
Object |
__namedParameters.mergeGlobals |
boolean |
__namedParameters.replaceHistory |
boolean |
Returns#
void
setRaw#
▸ setRaw(value): void
Set stringified raw value(s) and update document.location.search
Parameters#
| Name | Type |
|---|---|
value |
string | string[] |
Returns#
void
stringify#
▸ stringify(value?): string[]
Parameters#
| Name | Type |
|---|---|
value |
V |
Returns#
string[]
toString#
▸ toString(__namedParameters?): string
Parameters#
| Name | Type |
|---|---|
__namedParameters |
Object |
__namedParameters.mergeGlobals |
boolean |
__namedParameters.value |
V |
__namedParameters.withPrefix |
boolean |
Returns#
string