Constants¶

Besides interfaces and bare types, A11yJSON defines the following constants.

Some lack proper formatting in the documentation. Fixes in tools/generate-overview.ts are welcome!

AccelerationSchema¶

SimpleSchema from the @sozialhelden/simpl-schema NPM package.

AccelerationSchemaDefinition¶

Validates a acceleration quantity object and will only accept acceleration units, eg. meter/second^2, miles/hour^2. Useful to describe the acceleration of a vehicle, or the acceleration that a person is subjected to.

SchemaDefinition from the @sozialhelden/simpl-schema NPM package.

AccessTypes¶

Read-only tuple with 15 strings:

• private
• public
• customers
• permissive
• yes
• no
• permit
• designated
• delivery
• emergency
• residents
• employees
• disabled
• yes
• no

BaseQuantitySchema¶

SimpleSchema from the @sozialhelden/simpl-schema NPM package.

BrightnessSchema¶

SimpleSchema from the @sozialhelden/simpl-schema NPM package.

BrightnessSchemaDefinition¶

Validates a brightness descriptor and will only accept brightness units, eg. nits or lumens.

SchemaDefinition from the @sozialhelden/simpl-schema NPM package.

DeskInteractions¶

Read-only tuple with 20 strings:

• changeHeight
• savePreset
• enqueue
• checkIn
• checkOut
• ringBell
• pay
• handoverLuggage
• handover
• getReturn
• getFood
• getShoppingBag
• scan
• selfCheckout
• open
• close
• unlock
• lock
• unlockAndLock
• openAndClose

DeskInteractionsSet¶

Set<One of the following strings:

changeHeight checkIn checkOut close enqueue getFood getReturn getShoppingBag handover handoverLuggage lock open openAndClose pay ringBell savePreset scan selfCheckout unlock unlockAndLock

>

DirectionAxes¶

Describes a physical direction axis relative to a person’s body.

Read-only tuple with 3 strings:

• sagittal
• coronal
• axial

Directions¶

Describes physical directions, from the perspective of a person facing forward.

Read-only tuple with 8 strings:

• up
• down
• left
• right
• forward
• backward
• clockwise
• counterclockwise

DoorInteractions¶

Read-only tuple with 7 strings:

• ringDoorbell
• open
• close
• unlock
• lock
• unlockAndLock
• openAndClose

DoorInteractionsSet¶

Set<One of the following strings:

close lock open openAndClose ringDoorbell unlock unlockAndLock

>

EquipmentInteractions¶

Read-only tuple with 21 strings:

• use
• selectFloor
• arriveAtFloor
• callEmergency
• ride
• travel
• buy
• sell
• call
• understand
• sleep
• toggle
• engage
• flush
• scan
• handover
• enable
• disable
• locateYourself
• findYourDestination
• getTreatment

EquipmentInteractionsSet¶

Set<One of the following strings:

arriveAtFloor buy call callEmergency disable enable engage findYourDestination flush getTreatment handover locateYourself ride scan selectFloor sell sleep toggle travel understand use

>

EquipmentTypes¶

Read-only tuple with 23 strings:

• bed
• wardrobe
• elevator
• escalator
• movingWalkway
• ramp
• hoist
• stairLift
• switch
• sitemap
• vendingMachine
• intercom
• powerOutlet
• flushMechanism
• bodyScanner
• luggageScanner
• ticketVendingMachine
• xrayMachine
• ctScanner
• mriScanner
• ultrasoundScanner
• wheelchairLift
• treatmentChair

ForceSchema¶

SimpleSchema from the @sozialhelden/simpl-schema NPM package.

ForceSchemaDefinition¶

Validates a force quantity object and will only accept force units, eg. newton, or kilogram*meter/second^2.

SchemaDefinition from the @sozialhelden/simpl-schema NPM package.

GenericInteractions¶

Read-only tuple with 27 strings:

• watchMovies
• watchPlays
• explore
• visit
• roam
• read
• rent
• watch
• see
• listen
• getFood
• getTreatment
• getService
• eat
• pay
• buy
• sell
• workHere
• arrive
• checkIn
• checkOut
• useLockers
• useService
• change
• use
• book
• play

GenericInteractionsSet¶

Set<One of the following strings:

arrive book buy change checkIn checkOut eat explore getFood getService getTreatment listen pay play read rent roam see sell use useLockers useService visit watch watchMovies watchPlays workHere

>

GrabBarsInteractions¶

Read-only tuple with 5 strings:

• localizeYourself
• findYourDestination
• foldUp
• foldDown
• adjust

GrabBarsInteractionsSet¶

Set<One of the following strings:

adjust findYourDestination foldDown foldUp localizeYourself

>

HertzSchema¶

SimpleSchema from the @sozialhelden/simpl-schema NPM package.

HertzSchemaDefinition¶

Validates a frequency quantity object and will only accept frequency units, eg. hertz.

SchemaDefinition from the @sozialhelden/simpl-schema NPM package.

IntercomInteractions¶

Read-only tuple with 6 strings:

• ring
• call
• hangUp
• open
• close
• identify

IntercomInteractionsSet¶

Set<One of the following strings:

call close hangUp identify open ring

>

LengthSchema¶

SimpleSchema from the @sozialhelden/simpl-schema NPM package.

LengthSchemaDefinition¶

Validates a length quantity object and will only accept length units, eg. meter, centimeter or inch.

SchemaDefinition from the @sozialhelden/simpl-schema NPM package.

MassSchema¶

SimpleSchema from the @sozialhelden/simpl-schema NPM package.

MassSchemaDefinition¶

Validates a mass quantity object and will only accept mass/weight units, eg. kilogram, gram or pound.

SchemaDefinition from the @sozialhelden/simpl-schema NPM package.

MediaInteractions¶

Read-only tuple with 11 strings:

• watch
• listen
• feel
• discover
• open
• close
• rent
• recognize
• browse
• read
• interact

MediaInteractionsSet¶

Set<One of the following strings:

browse close discover feel interact listen open read recognize rent watch

>

MediaTypeSet¶

Set<One of the following strings:

document exhibit form guide menu movie play presentation screen tour website

>

MediaTypes¶

Read-only tuple with 11 strings:

• document
• menu
• guide
• tour
• presentation
• exhibit
• movie
• play
• screen
• website
• form

MirrorInteractions¶

Read-only tuple with 5 strings:

• turn
• adjust
• move
• clean
• use

MirrorInteractionsSet¶

Set<One of the following strings:

adjust clean move turn use

>

Operators¶

The allowed operators for comparison quantities

Read-only tuple with 9 strings:

• <
• <=
• ==
• >=
• >
• =
• ~
• ~=
• !=

ParkingInteractions¶

Read-only tuple with 4 strings:

• park
• enterVehicle
• exitVehicle
• arrive

ParkingInteractionsSet¶

Set<One of the following strings:

arrive enterVehicle exitVehicle park

>

PaymentInteractions¶

Read-only tuple with 5 strings:

• pay
• checkIn
• logIn
• logOut
• register

QueueSystemInteractions¶

Read-only tuple with 9 strings:

• enqueue
• skipQueue
• wait
• leaveQueue
• arrive
• checkIn
• checkOut
• getTicket
• getOnesTurn

QueueSystemInteractionsSet¶

Set<One of the following strings:

arrive checkIn checkOut enqueue getOnesTurn getTicket leaveQueue skipQueue wait

>

RestroomSignIcons¶

Read-only tuple with 10 strings:

• allGender
• female
• male
• personInWheelchair
• changingTable
• baby
• family
• urinal
• washBasin
• toiletBowl

RoomInteractions¶

Read-only tuple with 13 strings:

• enter
• exit
• stand
• sit
• see
• sleep
• play
• wait
• storeThings
• lookAround
• openWindow
• closeWindow
• callEmergency

RoomInteractionsSet¶

Set<One of the following strings:

callEmergency closeWindow enter exit lookAround openWindow play see sit sleep stand storeThings wait

>

SeatInteractions¶

Read-only tuple with 22 strings:

• sit
• fold
• unfold
• move
• adjust
• adjustHeight
• adjustSeatingSurface
• adjustSeatingAngle
• adjustArmRests
• removeArmrests
• adjustHeadRest
• adjustLegRest
• adjustBackRest
• adjustFootRest
• adjustSeatBelt
• adjustSeatBeltLength
• adjustSeatBeltHeight
• adjustSeatBeltAngle
• adjustSeatBeltPosition
• adjustSeatBeltTension
• adjustSeatBeltLock
• connectSeatbelt

SeatInteractionsSet¶

Set<One of the following strings:

adjust adjustArmRests adjustBackRest adjustFootRest adjustHeadRest adjustHeight adjustLegRest adjustSeatBelt adjustSeatBeltAngle adjustSeatBeltHeight adjustSeatBeltLength adjustSeatBeltLock adjustSeatBeltPosition adjustSeatBeltTension adjustSeatingAngle adjustSeatingSurface connectSeatbelt fold move removeArmrests sit unfold

>

ShowerInteractions¶

Read-only tuple with 9 strings:

• transfer
• wash
• useShampoo
• useShowerGel
• useSoap
• useConditioner
• useShowerCurtain
• useShowerHead
• useSupport

ShowerInteractionsSet¶

Set<One of the following strings:

transfer useConditioner useShampoo useShowerCurtain useShowerGel useShowerHead useSoap useSupport wash

>

SignageInteractions¶

Read-only tuple with 3 strings:

• locateYourself
• findYourDestination
• useSitemap

SignageInteractionsSet¶

Set<One of the following strings:

findYourDestination locateYourself useSitemap

>

SlopeSchema¶

SimpleSchema from the @sozialhelden/simpl-schema NPM package.

SlopeSchemaDefinition¶

Validates a slope quantity object and will only accept units to descrie a slope, eg. degrees.

SchemaDefinition from the @sozialhelden/simpl-schema NPM package.

SmoothnessTypeValues¶

Read-only tuple with 9 strings:

• excellent
• good
• intermediate
• bad
• horrible
• impassable
• very_bad
• very_horrible
• very_good

SpeedSchema¶

SimpleSchema from the @sozialhelden/simpl-schema NPM package.

SpeedSchemaDefinition¶

Validates a speed quantity object and will only accept speed units, eg. meter/second, miles/hour or similar.

SchemaDefinition from the @sozialhelden/simpl-schema NPM package.

SurfaceTypeValues¶

Read-only tuple with 158 strings:

• acrylic
• aluminium
• anti-slip
• artificial
• artificial_grass
• artificial_turf
• asfalto
• ash
• asphalt
• astroturf
• bamboo
• bare_rock
• bark
• barkchips
• bedrock
• bitumen
• bituminous
• block
• boardwalk
• boulders
• brick
• brick_weave
• bricks
• bushes
• carpet
• cement
• chalk
• chipseal
• cinder
• clay
• cobblestone
• compacted
• compacted_gravel
• composite
• con
• concrete
• concrete_slab
• concrete_slabs
• construction
• coral
• coral_sand
• crushed_limestone
• crushed_shells
• debris
• decoturf
• dirt
• earth
• enrobé
• fine_gravel
• fine_sand
• flagstone
• footway
• glass
• goudron
• granite
• grass
• grass_paver
• grass_scrub
• grassland
• grating
• gravel
• green
• grit
• ground
• hardcore
• ice
• ice_road
• interlock
• iron
• laterite
• lawn
• leaves
• limerock
• limestone
• linoleum
• loose_gravel
• marble
• marble_plate
• meadow
• metal
• metal_grid
• mixed
• moss
• mud
• mulch
• native
• natural
• none
• oil
• overgrown
• path
• paved
• pavement
• paving
• paving_stone
• paving_stones
• peat
• pebbles
• pebblestone
• plank
• plastic
• plates
• rasin
• residential
• rock
• rocks
• rocky
• roman_paving
• rubber
• rubbercrumb
• rubble
• salt
• sand
• sandstone
• sawdust
• scree
• scrub
• sealed
• sett
• shell
• shells
• shingle
• slabs
• snow
• soil
• spur
• steel
• stepping_stones
• stone
• stones
• synthetic
• tactile_paving
• tar
• tared
• tarmac
• tartan
• terra
• terre
• tile
• tiles
• timber
• track
• trail
• trees
• tuff
• turf
• undefined
• unhewn_cobblestone
• unpaved
• unpaved2
• unpaved33
• unpaved_minor
• unsealed
• water
• wood
• wood_chips
• woodchips
• zebra

TemperatureSchema¶

SimpleSchema from the @sozialhelden/simpl-schema NPM package.

TemperatureSchemaDefinition¶

Validates a temperature quantity object and will only accept temperature units, eg. degrees celsius (degC), degrees Fahrenheit (degF) or kelvin (K).

SchemaDefinition from the @sozialhelden/simpl-schema NPM package.

TimeIntervalSchema¶

SimpleSchema from the @sozialhelden/simpl-schema NPM package.

TimeIntervalSchemaDefinition¶

Validates a timer interval object and will only accept time units, eg. seconds, minutes or hours.

SchemaDefinition from the @sozialhelden/simpl-schema NPM package.

ToiletInteractions¶

Read-only tuple with 4 strings:

• use
• flush
• secondaryFlush
• spray

ToiletInteractionsSet¶

Set<One of the following strings:

flush secondaryFlush spray use

>

UnitlessSchema¶

SimpleSchema from the @sozialhelden/simpl-schema NPM package.

UnitlessSchemaDefinition¶

SchemaDefinition from the @sozialhelden/simpl-schema NPM package.

Urgencies¶

Read-only tuple with 5 strings:

• alert
• alarm
• warning
• info
• debug

VolumeSchema¶

SimpleSchema from the @sozialhelden/simpl-schema NPM package.

VolumeSchemaDefinition¶

Validates a sound volume quantity object and will only accept sound volume units, eg. decibel.

SchemaDefinition from the @sozialhelden/simpl-schema NPM package.

WashBashinInteractions¶

Read-only tuple with 13 strings:

• changeTemperature
• changeWaterPressure
• useWater
• getHotWater
• getColdWater
• getCarbonizedWater
• useWaterJet
• useWaterSpray
• useSoap
• getTowel
• getPaperTowel
• useAirDryer
• sanitizeHands

WashBasinInteractionsSet¶

Set<One of the following strings:

changeTemperature changeWaterPressure getCarbonizedWater getColdWater getHotWater getPaperTowel getTowel sanitizeHands useAirDryer useSoap useWater useWaterJet useWaterSpray

>

WheelchairAccessibilityGrades¶

Describes the general wheelchair accessibility of the place. This is a human-rated value. It SHOULD conform to the traffic light system found in OpenStreetMap and Wheelmap.org.

Read-only tuple with 3 strings:

• fully
• partially
• not

WifiInteractions¶

Read-only tuple with 6 strings:

• login
• register
• getPassword
• getGuestPass
• getTerms
• acceptTerms

WifiInteractionsSet¶

Set<One of the following strings:

acceptTerms getGuestPass getPassword getTerms login register

>

smokingPolicies¶

Describes smoking policies for visitors of a place.

Read-only tuple with 6 strings:

• dedicatedToSmoking
• allowedEverywhere
• inSeparateArea
• inIsolatedArea
• prohibited
• onlyOutside