Skip to content

Type Aliases

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

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

Acceleration

Definition: Quantity | string

AccessType

Definition: one of the following strings:

  • private

  • public

  • customers

  • permissive

  • yes

  • no

  • permit

  • designated

  • delivery

  • emergency

  • residents

  • employees

  • disabled

  • yes

  • no

Brightness

Definition: Quantity | string

DeskInteraction

Definition: one of the following strings:

  • changeHeight

  • savePreset

  • enqueue

  • checkIn

  • checkOut

  • ringBell

  • pay

  • handoverLuggage

  • handover

  • getReturn

  • getFood

  • getShoppingBag

  • scan

  • selfCheckout

  • open

  • close

  • unlock

  • lock

  • unlockAndLock

  • openAndClose

Direction

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

Definition: one of the following strings:

  • up

  • down

  • left

  • right

  • forward

  • backward

  • clockwise

  • counterclockwise

DirectionAxis

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

Definition: one of the following strings:

  • sagittal

  • coronal

  • axial

DoorInteraction

Definition: one of the following strings:

  • ringDoorbell

  • open

  • close

  • unlock

  • lock

  • unlockAndLock

  • openAndClose

EquipmentInteraction

Definition: one of the following strings:

  • use

  • selectFloor

  • arriveAtFloor

  • callEmergency

  • ride

  • travel

  • buy

  • sell

  • call

  • understand

  • sleep

  • toggle

  • engage

  • flush

  • scan

  • handover

  • enable

  • disable

  • locateYourself

  • findYourDestination

EquipmentType

Definition: one of the following strings:

  • bed

  • wardrobe

  • elevator

  • escalator

  • movingWalkway

  • ramp

  • hoist

  • stairLift

  • switch

  • sitemap

  • vendingMachine

  • intercom

  • powerOutlet

  • flushMechanism

  • bodyScanner

  • luggageScanner

Force

Definition: Quantity | string

GenericInteraction

Definition: one of the following strings:

  • watchMovies

  • watchPlays

  • explore

  • visit

  • roam

  • read

  • rent

  • watch

  • see

  • listen

  • getFood

  • eat

  • pay

  • buy

  • sell

  • workHere

  • arrive

  • checkIn

  • checkOut

  • useLockers

  • change

  • use

  • book

  • play

GrabBarsInteraction

Definition: one of the following strings:

  • localizeYourself

  • findYourDestination

  • foldUp

  • foldDown

  • adjust

Hertz

Definition: Quantity | string

IETFLanguageTag

Defines a spoken or written language in IETF language tag format.

Definition: string

IntercomInteraction

Definition: one of the following strings:

  • ring

  • call

  • hangUp

  • open

  • close

  • identify

Length

Definition: Quantity | string

LocalizedString

Definition: Object with one or more of these keys:

string

Values must be of type string.

Mass

Definition: Quantity | string

MediaInteraction

Definition: one of the following strings:

  • watch

  • listen

  • feel

  • discover

  • open

  • close

  • rent

  • recognize

  • browse

  • read

  • interact

MediaType

Definition: one of the following strings:

  • document

  • menu

  • guide

  • tour

  • presentation

  • exhibit

  • movie

  • play

  • screen

  • website

MirrorInteraction

Definition: one of the following strings:

  • turn

  • adjust

  • move

  • clean

  • use

Operator

Definition: one of the following strings:

  • <

  • <=

  • ==

  • >=

  • >

  • =

  • ~

  • ~=

  • !=

ParkingInteraction

Definition: one of the following strings:

  • park

  • enterVehicle

  • exitVehicle

  • arrive

Paymentnteraction

Definition: one of the following strings:

  • pay

  • checkIn

  • logIn

  • logOut

  • register

QueueSystemInteraction

Definition: one of the following strings:

  • enqueue

  • skipQueue

  • wait

  • leaveQueue

  • arrive

  • checkIn

  • checkOut

  • getTicket

  • getOnesTurn

RestroomSignIcon

Definition: one of the following strings:

  • allGender

  • female

  • male

  • personInWheelchair

  • changingTable

  • baby

  • family

  • urinal

  • washBasin

  • toiletBowl

RoomInteraction

Definition: one of the following strings:

  • enter

  • exit

  • stand

  • sit

  • see

  • sleep

  • play

  • wait

  • storeThings

  • lookAround

  • openWindow

  • closeWindow

SeatInteraction

Definition: one of the following strings:

  • sit

  • fold

  • unfold

  • move

  • adjust

  • adjustHeight

  • adjustSeatingSurface

  • adjustSeatingAngle

  • adjustArmRests

  • adjustHeadRest

  • adjustLegRest

  • adjustBackRest

  • adjustFootRest

  • adjustSeatBelt

  • adjustSeatBeltLength

  • adjustSeatBeltHeight

  • adjustSeatBeltAngle

  • adjustSeatBeltPosition

  • adjustSeatBeltTension

  • adjustSeatBeltLock

  • connectSeatbelt

ShowerInteraction

Definition: one of the following strings:

  • transfer

  • wash

  • useShampoo

  • useShowerGel

  • useSoap

  • useConditioner

  • useShowerCurtain

  • useShowerHead

  • useSupport

SignageInteraction

Definition: one of the following strings:

  • locateYourself

  • findYourDestination

  • useSitemap

Slope

Definition: Quantity | string

SmokingPolicy

Describes the smoking policy for visitors of a place.

Definition: one of the following strings:

  • dedicatedToSmoking

  • allowedEverywhere

  • inSeparateArea

  • inIsolatedArea

  • prohibited

  • onlyOutside

SmoothnessType

Definition: one of the following strings:

  • excellent

  • good

  • intermediate

  • bad

  • horrible

  • impassable

  • very_bad

  • very_horrible

  • very_good

Speed

Definition: Quantity | string

SurfaceType

Definition: one of the following 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

Temperature

Definition: Quantity | string

TimeInterval

Definition: Quantity | string

ToiletInteraction

Definition: one of the following strings:

  • use

  • flush

  • secondaryFlush

  • spray

Urgency

Definition: one of the following strings:

  • alert

  • alarm

  • warning

  • info

  • debug

Volume

Definition: Quantity | string

WashBashinInteraction

Definition: one of the following strings:

  • changeTemperature

  • changeWaterPressure

  • useWater

  • getHotWater

  • getColdWater

  • getCarbonizedWater

  • useWaterJet

  • useWaterSpray

  • useSoap

  • getTowel

  • getPaperTowel

  • useAirDryer

  • sanitizeHands

WheelchairAccessibilityGrade

Definition: one of the following strings:

  • fully

  • partially

  • not

WifiInteraction

Definition: one of the following strings:

  • login

  • register

  • getPassword

  • getGuestPass

  • getTerms

  • acceptTerms