Schema Catalog - Vani API Documentation

Shape

#

Shape schema.

Field	Type		Description
text	Text	OPTIONAL	Shape text content.
properties	Shape Properties	OPTIONAL	Visual properties.
placeholder	Placeholder	OPTIONAL	Placeholder binding.

Geometry — exactly one of the following

basic Basic Shape Basic shape geometry.

flowchart Flowchart Shape Flowchart shape geometry.

block_arrow Block Arrow Shape Block arrow geometry.

mathematical_symbol Mathematical Symbol Shape Mathematical symbol geometry.

star Star Shape Star geometry.

callout Callout Shape Callout geometry.

custom Custom Shape Path-based custom geometry.

Basic Shape

#

Basic shape schema.

Field	Type		Description
type	enum	REQUIRED	Basic shape family. type40 RECTANGLEROUNDED_RECTANGLESNIP_RECTANGLEROUND_SNIP_RECTANGLETRIANGLEOVALTRAPEZOIDPENTAGONHEXAGONDIAMONDPARALLELOGRAMHEPTAGONOCTAGONDECAGONPIECHORDTEARDROPFRAMEHALF_FRAMEL_SHAPEDIAGONAL_STRIPECROSSPLAQUECANCUBEBEVELDONUTNO_SYMBOLBLOCK_ARCFOLDED_CORNERSMILEYHEARTLIGHTNING_BOLTSUNMOONCLOUDARCBRACKETBRACECLOCK
rounded_rectangle	Rounded Rectangle	OPTIONAL	Rounded rectangle detail.
snip_rectangle	Snip Rectangle	OPTIONAL	Snip rectangle detail.
triangle	Triangle	OPTIONAL	Triangle detail.
bracket	Bracket	OPTIONAL	Bracket detail.
brace	Brace	OPTIONAL	Brace detail.

Rounded Rectangle

#

Detail object used with <code>basic.rounded_rectangle</code>.

Field	Type		Description
type	enum	REQUIRED	Rounded rectangle type. type4 NORMALSINGLESAME_SIDEDIAGONAL

Snip Rectangle

#

Detail object used with <code>basic.snip_rectangle</code>.

Field	Type		Description
type	enum	REQUIRED	Snip rectangle type. type3 SNIP_SINGLESNIP_SAME_SIDESNIP_DIAGONAL

Triangle

#

Detail object used with <code>basic.triangle</code>.

Field	Type		Description
type	enum	REQUIRED	Triangle type. type2 ISOSCELESRIGHT_ANGLED

Bracket

#

Detail object used with <code>basic.bracket</code>.

Field	Type		Description
type	enum	REQUIRED	Bracket type. type3 DOUBLERIGHTLEFT

Brace

#

Detail object used with <code>basic.brace</code>.

Field	Type		Description
type	enum	REQUIRED	Brace type. type3 DOUBLERIGHTLEFT

Text

#

Text schema.

Field	Type		Description
paragraphs	Text Paragraph[]	OPTIONAL	Text paragraphs.
properties	Text Box Properties	OPTIONAL	Text properties.
placeholder	Placeholder	OPTIONAL	Placeholder binding.

Text Paragraph

#

Text paragraph schema.

Field	Type		Description
id	string	REQUIRED	Paragraph ID. Must be a UUID.
portions	Text Portion[]	OPTIONAL	Text portions. Each portion contains text content and optional style.
style	Paragraph Style	OPTIONAL	Paragraph style.

Text Portion

#

Text portion schema.

Field	Type		Description
text	string	OPTIONAL	Text run content.
style	Portion Style	OPTIONAL	Portion style.

Portion Style

#

Character-level text styling.

Field	Type		Description
font_name	Font Name	OPTIONAL	Font family.
size	float	OPTIONAL	Font size.
fontweight	enum	OPTIONAL	Selects one of the supported values. fontweight9 THINEXTRA_LIGHTLIGHTNORMALMEDIUMDEMI_BOLDBOLDHEAVYBLACK
italic	boolean	OPTIONAL	Italic text toggle.
underline	boolean	OPTIONAL	Underline text toggle.
strike	boolean	OPTIONAL	Strikethrough text toggle.
color	Color	OPTIONAL	Text color.

Font Name

#

Font name schema.

Field	Type		Description
name	enum	OPTIONAL	Selects one of the supported values. name125 AbelAdaminaAguafina ScriptAlegreyaAlfa Slab OneAnticAntic DidoneAntic SlabAntonArapeyArchitects DaughterArchivoArchivo BlackArvoAveria Serif LibreBad ScriptBarlowBenthamBigshot OneBilbo Swash CapsBree SerifBubbler OneCabinCabin CondensedCabin SketchCaveatChivoComfortaaCookieCourier PrimeCoustardCrimson TextDancing ScriptDejaVu SansDidact GothicDoppio OneDosisDroid SansDroid SerifEconomicaExoFinger PaintFlamencoGabrielaGreat VibesIBM Plex MonoInterItalianaJockey OneJosefin SansJosefin SlabJuraJust Another HandKalamKaushan ScriptLatoLeague GothicLobsterLuckiest GuyMagraMarck ScriptMetrophobicMichromaMiltonianMolleMonotonMontezMontserratNiconneNixie OneNosiferNova CutNunitoOffice Code ProOld Standard TTOpen SansOreganoOSP DINOswaldOtama epPacificoParisiennePatua OnePermanent MarkerPhilosopherPlayballPlayfair DisplayPompierePoppinsPT SansQuandoQuestrialQuicksandQwigleyRacing Sans OneRalewayRobotoRochesterRock SaltRokkittRopa SansRubikSansationSatisfySawarabi GothicSchoolbellShort StackSignikaSource Code ProSource Sans ProSource Serif ProSpecial EliteSpicy RiceSquada OneSyncopateTekoTeXGyreAdventorTitillium WebTrade WindsUbuntuUnkemptUnnaVollkornYesteryearZoho Puvi

Color

#

Color schema.

Color Model — exactly one of the following

rgb RGB Color RGB channel color.

hsb HSB Color HSB color.

hex HEX Color HEX literal color.

Paragraph Style

#

Paragraph style schema.

Field	Type		Description
halign	enum	OPTIONAL	Selects one of the supported values. halign4 LEFTCENTERRIGHTJUSTIFY
spacing	Paragraph Spacing	OPTIONAL	Paragraph spacing.
level	int	OPTIONAL	Paragraph indent level.
portion_style	Portion Style	OPTIONAL	Default portion style for the paragraph.

Paragraph Spacing

#

Paragraph spacing schema.

Field	Type		Description
line	float	OPTIONAL	Line spacing multiplier.
before	int	OPTIONAL	Space before paragraph.
after	int	OPTIONAL	Space after paragraph.

Text Box Properties

#

Text box properties schema.

Field	Type		Description
valign	enum	OPTIONAL	Selects one of the supported values. valign3 MIDDLETOPBOTTOM
inset	Text Inset	OPTIONAL	Text padding.
para_style	Paragraph Style	OPTIONAL	Default paragraph style.
auto_fit	enum	OPTIONAL	Selects one of the supported values. auto_fit3 NONETEXTSHAPE

Text Inset

#

Text inset schema.

Field	Type		Description
left	float	OPTIONAL	Left text padding.
top	float	OPTIONAL	Top text padding.
right	float	OPTIONAL	Right text padding.
bottom	float	OPTIONAL	Bottom text padding.

Placeholder

#

Placeholder schema.

Field	Type		Description
type	enum	REQUIRED	Vani placeholder type. Use <code>TXT</code> for text placeholders, <code>PICT</code> for image placeholders, <code>TABLE</code> for table placeholders, or <code>VIDEO</code> for video placeholders. type4 TXTPICTTABLEVIDEO

Shape Properties

#

Shape properties schema.

Field	Type		Description
layout	Layout	OPTIONAL	Position and size.
fills	Fill[]	OPTIONAL	Fill layers.
strokes	Stroke[]	OPTIONAL	Stroke layers.

Layout

#

Layout schema.

Field	Type		Description
top	float	OPTIONAL	Top position (Y).
left	float	OPTIONAL	Left position (X).
width	float	OPTIONAL	Element width in pixels.
height	float	OPTIONAL	Element height in pixels.
rotate	int	OPTIONAL	Rotation angle in degrees.
fliph	boolean	OPTIONAL	Horizontal flip.
flipv	boolean	OPTIONAL	Vertical flip.

Fill

#

Fill schema.

Field	Type		Description
alpha	float	OPTIONAL	Transparency ratio. Range: 0 to 1.

Fill Type — exactly one of the following

solid Solid Fill Solid fill.

gradient Gradient Fill Gradient fill.

no_fill object No fill object.

Solid Fill

#

Solid fill schema.

Field	Type		Description
color	Color	REQUIRED	Fill color.

Gradient Fill

#

Gradient fill schema.

Field	Type		Description
type	enum	OPTIONAL	Gradient type. type3 LINEARRADIALANGULAR
stops	Gradient Stop[]	REQUIRED	Gradient color stops. Minimum two stops are required.
linear	Linear Geometry	CONDITIONAL	Geometry for LINEAR gradients.
radial_angular	Radial Angular Geometry	CONDITIONAL	Geometry for RADIAL and ANGULAR gradients.

Gradient Stop

#

Gradient stop schema.

Field	Type		Description
color	Color	REQUIRED	Stop color.
position	float	REQUIRED	Stop position. Range: 0 to 1.

Linear Geometry

#

Linear geometry schema.

Field	Type		Description
start	Point	REQUIRED	Gradient axis start point.
end	Point	REQUIRED	Gradient axis end point.

Point

#

2D point with x and y coordinates.

Field	Type		Description
x	float	REQUIRED	X coordinate.
y	float	REQUIRED	Y coordinate.

Radial Angular Geometry

#

Radial angular geometry schema.

Field	Type		Description
center	Point	REQUIRED	Gradient center point.
spread_x	float	OPTIONAL	Horizontal spread.
spread_y	float	OPTIONAL	Vertical spread.
rotation_angle	float	OPTIONAL	Rotation in degrees.
flip_horizontal	boolean	OPTIONAL	Mirror horizontally.
flip_vertical	boolean	OPTIONAL	Mirror vertically.

Stroke

#

Shape stroke schema.

Field	Type		Description
type	enum	OPTIONAL	Stroke type. For no border, keep the type valid and set the stroke fill to no_fill. type3 SOLIDDASHSQUARE_DOT
width	float	OPTIONAL	Stroke width in pixels.
jointype	enum	OPTIONAL	Join type. jointype3 ROUNDBEVELMITER
captype	enum	OPTIONAL	Cap type. captype3 FLATCAPROUNDSQUARE
position	enum	OPTIONAL	Stroke position. position3 CENTERINSIDEOUTSIDE
fill	Stroke Fill	OPTIONAL	Stroke fill.

Stroke Fill

#

Stroke Fill schema.

Field	Type		Description
alpha	float	OPTIONAL	Stroke fill alpha ratio. Range: 0 to 1.

Stroke Fill Type — exactly one of the following

solid Solid Fill Solid stroke fill.

no_fill object No stroke fill. Use this for no border.

Block Arrow Shape

#

Use <code>type</code> to select the block-arrow family.

Field	Type		Description
type	enum	REQUIRED	Block arrow family. type15 SINGLECURVEDCALLOUTDOUBLEQUADLEFT_RIGHT_UPBENTU_TURNBENT_UPSTRIPED_RIGHTNOTCHED_RIGHTPENTAGON_ARROWCHEVRONLEFT_RIGHT_CALLOUTQUAD_CALLOUT
single_arrow	Single Arrow	OPTIONAL	Single arrow direction.
curved_arrow	Curved Arrow	OPTIONAL	Curved arrow direction.
arrow_callout	Arrow Callout	OPTIONAL	Arrow callout direction.
double_arrow	Double Arrow	OPTIONAL	Double arrow direction.

Single Arrow

#

Direction object used with <code>block_arrow.single_arrow</code>.

Field	Type		Description
type	enum	REQUIRED	Single arrow direction. type4 RIGHTLEFTTOPBOTTOM

Curved Arrow

#

Direction object used with <code>block_arrow.curved_arrow</code>.

Field	Type		Description
type	enum	REQUIRED	Curved arrow direction. type4 RIGHTLEFTTOPBOTTOM

Arrow Callout

#

Direction object used with <code>block_arrow.arrow_callout</code>.

Field	Type		Description
type	enum	REQUIRED	Arrow callout direction. type4 RIGHTLEFTTOPBOTTOM

Double Arrow

#

Direction object used with <code>block_arrow.double_arrow</code>.

Field	Type		Description
type	enum	REQUIRED	Double arrow direction. type3 UP_DOWNLEFT_RIGHTLEFT_UP

Flowchart Shape

#

Flowchart shape schema.

Field	Type		Description
type	enum	REQUIRED	Flowchart shape type. type28 PREDEFINED_PROCESSINTERNAL_STORAGEDOCUMENTPROCESSALTERNATE_PROCESSDECISIONDATAMULTI_DOCUMENTTERMINATORPREPARATIONMANUAL_INPUTMANUAL_OPERATIONCONNECTOROFFPAGE_CONNECTORPUNCHED_CARDPUNCHED_TAPESUMMING_JUNCTIONORCOLLATESORTEXTRACTMERGESTORED_DATADELAYSEQUENTIAL_ACCESS_STORAGEMAGNETIC_DISKDIRECT_ACCESS_STORAGEDISPLAY

Mathematical Symbol Shape

#

Mathematical symbol geometry selector.

Field	Type		Description
type	enum	REQUIRED	Mathematical symbol type. type6 PLUSMINUSMULTIPLYDIVIDEEQUALNOT_EQUAL

Star Shape

#

Star shape schema.

Field	Type		Description
type	enum	REQUIRED	Star family. type5 EXPLOSIONPOINTRIBBONSCROLLWAVE
point	Star Point	OPTIONAL	Star point detail.
ribbon	Star Ribbon	OPTIONAL	Ribbon detail.
scroll	Star Scroll	OPTIONAL	Scroll detail.
wave	Star Wave	OPTIONAL	Wave detail.

Star Point

#

Detail object used with <code>star.point</code>.

Field	Type		Description
type	enum	REQUIRED	Star point type. type10 FOUR_POINTFIVE_POINTSIX_POINTSEVEN_POINTEIGHT_POINTTEN_POINTTWELVE_POINTSIXTEEN_POINTTWENTY_FOUR_POINTTHIRTY_TWO_POINT

Star Ribbon

#

Detail object used with <code>star.ribbon</code>.

Field	Type		Description
type	enum	REQUIRED	Ribbon type. type4 UPDOWNCURVED_UPCURVED_DOWN

Star Scroll

#

Detail object used with <code>star.scroll</code>.

Field	Type		Description
type	enum	REQUIRED	Scroll type. type2 VERTICALHORIZONTAL

Star Wave

#

Detail object used with <code>star.wave</code>.

Field	Type		Description
type	enum	REQUIRED	Wave type. type2 SINGLEDOUBLE

Callout Shape

#

Callout shape schema.

Field	Type		Description
type	enum	REQUIRED	Callout shape type. type5 LINERECTANGLE_CALLOUTROUNDED_RECTANGLE_CALLOUTOVAL_CALLOUTCLOUD_CALLOUT

Custom Shape

#

Custom shape schema.

Field	Type		Description
width	float	OPTIONAL	Custom shape width.
height	float	OPTIONAL	Custom shape height.
paths	Custom Path[]	REQUIRED	Shape paths.

Custom Path

#

Custom path schema.

Field	Type		Description
commands	Path Command[]	REQUIRED	Ordered path command objects.

Path Command

#

Path Command schema.

Path Command — exactly one of the following

move_to Path Point Command Move to a point.

line_to Path Point Command Draw a line to a point.

cubic_to Cubic Path Command Draw a cubic Bezier curve.

quadratic_to Quadratic Path Command Draw a quadratic Bezier curve.

arc_to Arc Path Command Draw an arc to a point.

smooth_cubic_to Smooth Cubic Path Command Draw a smooth cubic Bezier curve.

smooth_quadratic_to Smooth Quadratic Path Command Draw a smooth quadratic Bezier curve.

close_path object Close the current path with an empty object.

Path Point Command

#

Path point command schema.

Field	Type		Description
point	Point	REQUIRED	Target point.

Cubic Path Command

#

Cubic path command schema.

Field	Type		Description
control1	Point	REQUIRED	First control point.
control2	Point	REQUIRED	Second control point.
end	Point	REQUIRED	End point.

Quadratic Path Command

#

Quadratic path command schema.

Field	Type		Description
control	Point	REQUIRED	Control point.
end	Point	REQUIRED	End point.

Arc Path Command

#

Arc path command schema.

Field	Type		Description
x_radius	float	OPTIONAL	X radius.
y_radius	float	OPTIONAL	Y radius.
start_angle	float	OPTIONAL	Start angle.
sweep_angle	float	OPTIONAL	Sweep angle.
end	Point	REQUIRED	End point.

Smooth Cubic Path Command

#

Smooth cubic path command schema.

Field	Type		Description
control2	Point	REQUIRED	Second control point.
end	Point	REQUIRED	End point.

Smooth Quadratic Path Command

#

Smooth quadratic path command schema.

Field	Type		Description
end	Point	REQUIRED	End point.

Connector

#

Connector schema.

Field	Type		Description
type	enum	OPTIONAL	Connector type. type3 LINEELBOWCURVE
connected	Connected Shapes	REQUIRED	Connected endpoint pair.
stroke	Connector Stroke	OPTIONAL	Connector stroke.
text	Connector Text	OPTIONAL	Connector label text.

Connected Shapes

#

Connected shapes schema.

Field	Type		Description
first	Connector Endpoint	REQUIRED	Start endpoint.
second	Connector Endpoint	REQUIRED	End endpoint.

Connector Endpoint

#

Connector endpoint schema.

Field	Type		Description
shape_id	string	REQUIRED	Connected shape ID.
side	enum	OPTIONAL	Connection side. side4 NORTHEASTSOUTHWEST
point	Point	OPTIONAL	Custom attach point.
marker	enum	OPTIONAL	Marker type. marker6 NONEOPENBLOCKCLASSICDIAMONDOVAL

Connector Stroke

#

Connector stroke schema.

Field	Type		Description
type	enum	OPTIONAL	Stroke type. type3 SOLIDDASHSQUARE_DOT
width	float	OPTIONAL	Stroke width in pixels.
jointype	enum	OPTIONAL	Join type. jointype3 ROUNDBEVELMITER
captype	enum	OPTIONAL	Cap type. captype3 FLATCAPROUNDSQUARE
position	enum	OPTIONAL	Stroke position. position3 CENTERINSIDEOUTSIDE
fill	Connector Stroke Fill	OPTIONAL	Connector stroke fill.

Connector Stroke Fill

#

Connector Stroke Fill schema.

Field	Type		Description
solid	Solid Fill	REQUIRED	Solid connector stroke fill.
alpha	float	OPTIONAL	Stroke fill alpha ratio. Range: 0 to 1.

Connector Text

#

Connector text schema.

Field	Type		Description
paragraphs	Text Paragraph[]	OPTIONAL	Text paragraphs.
properties	Text Box Properties	OPTIONAL	Text properties.

RGB Color

#

RGB color schema.

Field	Type		Description
red	int	REQUIRED	Red channel. Range: 0–255.
green	int	REQUIRED	Green channel. Range: 0–255.
blue	int	REQUIRED	Blue channel. Range: 0–255.

HSB Color

#

HSB color schema.

Field	Type		Description
hue	float	REQUIRED	Hue. Range: 0–360.
saturation	float	REQUIRED	Saturation. Range: 0–1.
brightness	float	REQUIRED	Brightness. Range: 0–1.

HEX Color

#

Hex color literal.

Field	Type		Description
value	string	REQUIRED	Hex color literal.

Text Mutation

#

Text Mutation schema.

Edit Target — exactly one of the following

range Range Text Mutation Edit text between two indexes.

cursor Cursor Text Mutation Edit text at one cursor index.

all_text All Text Mutation Edit the full text content.

Range Text Mutation

#

Use <code>range</code> when the text edit applies only to part of the text.

Field	Type		Description
range	Text Range	REQUIRED	Nested index range object.
operation	enum	REQUIRED	What to do with the selected range. operation2 RANGE_TEXT_OPERATION_REPLACERANGE_TEXT_OPERATION_DELETE
replacement_text	string	OPTIONAL	New text to put in the selected range when the operation is <code>RANGE_TEXT_OPERATION_REPLACE</code>.

Text Range

#

Text range schema.

Field	Type		Description
start_index	int	REQUIRED	Where the range starts. This index is included.
end_index	int	REQUIRED	Where the range ends. This index is not included.

Cursor Text Mutation

#

Use <code>cursor</code> when the text edit happens at one cursor index.

Field	Type		Description
cursor_index	int	REQUIRED	The text index where the cursor edit should happen.
operation	enum	REQUIRED	What to do at the cursor. operation3 CURSOR_TEXT_OPERATION_INSERT_TEXTCURSOR_TEXT_OPERATION_INSERT_NEWLINECURSOR_TEXT_OPERATION_DELETE_NEWLINE
text	string	OPTIONAL	Text to insert when the operation is <code>CURSOR_TEXT_OPERATION_INSERT_TEXT</code>.

All Text Mutation

#

Use <code>all_text</code> when the text edit applies to the full text content.

Field	Type		Description
operation	enum	REQUIRED	What to do with the full text. operation2 ALL_TEXT_OPERATION_REPLACEALL_TEXT_OPERATION_DELETE
replacement_text	string	OPTIONAL	New full text when the operation is <code>ALL_TEXT_OPERATION_REPLACE</code>.

Frame

#

Frame schema.

Field	Type		Description
meta	Frame Meta	REQUIRED	Frame metadata.
type	enum	REQUIRED	Selects one of the supported values. type20 A4A5A6A7SLIDE_LANDSCAPESLIDE_PORTRAITDEVICE_PHONEDEVICE_TABLETDEVICE_DESKTOPDEVICE_TVDEVICE_WATCHSM_TWITTER_POSTSM_TWITTER_HEADERSM_FB_POSTSM_FB_COVERSM_INSTAGRAM_POSTSM_INSTAGRAM_STORYSM_LINKEDIN_POSTSM_LINKEDIN_COVERCUSTOM
properties	Frame Properties	OPTIONAL	Frame visual properties.

Frame Meta

#

Frame metadata schema.

Field	Type		Description
id	string	REQUIRED	Frame ID. Must be a UUID.
name	string	OPTIONAL	Frame display name.

Frame Properties

#

Frame properties schema.

Field	Type		Description
layout	Layout	OPTIONAL	Position and size.
fills	Fill[]	OPTIONAL	Fill layers.
strokes	Stroke[]	OPTIONAL	Stroke layers.

Asset Ref

#

Asset Ref schema.

Field	Type		Description
library	Library Asset Ref	OPTIONAL	—
local_id	string	OPTIONAL	—

Auto Layout

#

Auto Layout schema.

Field	Type		Description
mode	string	OPTIONAL	— mode4 NONEHORIZONTALVERTICALGRID
vertical_scale	string	OPTIONAL	— vertical_scale3 FIXEDFILLHUG
horizontal_spacing	object	OPTIONAL	—
padding	object	OPTIONAL	—
horizontal_scale	string	OPTIONAL	— horizontal_scale3 FIXEDFILLHUG
vertical_align	string	OPTIONAL	— vertical_align3 MIDDLETOPBOTTOM
grid	object	OPTIONAL	—
horizontal_align	string	OPTIONAL	— horizontal_align4 LEFTCENTERRIGHTJUSTIFY
vertical_spacing	object	OPTIONAL	—
wrap	boolean	OPTIONAL	—

Chart

#

Chart schema.

Field	Type		Description
layout	Layout	OPTIONAL	—
area	Chart_ Area Chart	OPTIONAL	—
bar	Chart_ Bar Chart	OPTIONAL	—
bubble	Chart_ Bubble Chart	OPTIONAL	—
line	Chart_ Line Chart	OPTIONAL	—
scatter	Chart_ Scatter Chart	OPTIONAL	—
column	Chart_ Bar Chart	OPTIONAL	—
axes	array of Chart_ChartAxis	OPTIONAL	—
chart_title	Chart_ Chart Title	OPTIONAL	—
pie	Chart_ Pie Chart	OPTIONAL	—
table	Table	OPTIONAL	—
doughnut	Chart_ Doughnut Chart	OPTIONAL	—

Chart_ Area Chart

#

Chart_ Area Chart schema.

Field	Type		Description
drop_lines	Stroke	OPTIONAL	—
grouping	string	OPTIONAL	— grouping3 CLUSTEREDSTACKEDPERCENT_STACKED

Chart_ Bar Chart

#

Chart_ Bar Chart schema.

Field	Type		Description
overlap	string	OPTIONAL	—
series_line	Stroke	OPTIONAL	—
gap	string	OPTIONAL	—
grouping	string	OPTIONAL	— grouping3 CLUSTEREDSTACKEDPERCENT_STACKED

Chart_ Bubble Chart

#

Chart_ Bubble Chart schema.

Field	Type		Description
bubble_size	object	OPTIONAL	—

Chart_ Chart Axis

#

Chart_ Chart Axis schema.

Field	Type		Description
minor_tick	Stroke	OPTIONAL	—
cross_axis	object	OPTIONAL	—
axis_id	string	OPTIONAL	—
axis_title	Chart_ Chart Title	OPTIONAL	—
position	string	OPTIONAL	— position5 TOPLEFTBOTTOMRIGHTCENTER
major_grid	Stroke	OPTIONAL	—
value_axis	object	OPTIONAL	—
major_tick	Stroke	OPTIONAL	—
minor_grid	Stroke	OPTIONAL	—

Chart_ Chart Title

#

Chart_ Chart Title schema.

Field	Type		Description
title	string	OPTIONAL	—

Chart_ Doughnut Chart

#

Chart_ Doughnut Chart schema.

Field	Type		Description
explosion	string	OPTIONAL	—
first_slice_angle	string	OPTIONAL	—
hole_size	string	OPTIONAL	—

Chart_ Line Chart

#

Chart_ Line Chart schema.

Field	Type		Description
up_bar	Fill	OPTIONAL	—
down_bar	Fill	OPTIONAL	—
high_low_lines	Stroke	OPTIONAL	—
line_settings	object	OPTIONAL	—
drop_lines	Stroke	OPTIONAL	—
grouping	string	OPTIONAL	— grouping3 CLUSTEREDSTACKEDPERCENT_STACKED

Chart_ Pie Chart

#

Chart_ Pie Chart schema.

Field	Type		Description
explosion	string	OPTIONAL	—
representative_pie	object	OPTIONAL	—
first_slice_angle	string	OPTIONAL	—

Chart_ Scatter Chart

#

Chart_ Scatter Chart schema.

Field	Type		Description
line	boolean	OPTIONAL	—
line_settings	object	OPTIONAL	—

Connector_ Connected Shape

#

Connector_ Connected Shape schema.

Field	Type		Description
first	object	OPTIONAL	—
second	object	OPTIONAL	—

Database Table

#

Database Table schema.

Field	Type		Description
layout	Layout	OPTIONAL	—
columns	array of DatabaseTable_DatabaseColumn	OPTIONAL	—
name	string	OPTIONAL	—
view_config	View Config	OPTIONAL	—
id	string	OPTIONAL	—
rows	array of DatabaseTable_DatabaseRow	OPTIONAL	—

Database Table View

#

Database Table View schema.

Field	Type		Description
layout	Layout	OPTIONAL	—
grid	object	OPTIONAL	—
kanban	object	OPTIONAL	—
name	string	OPTIONAL	—
view_config	View Config	OPTIONAL	—
id	string	OPTIONAL	—
table_id	string	OPTIONAL	—

Database Table_ Database Column

#

Database Table_ Database Column schema.

Field	Type		Description
relation_column	object	OPTIONAL	—
rollup_column	object	OPTIONAL	—
unique	boolean	OPTIONAL	—
name	string	OPTIONAL	—
lookup_column	object	OPTIONAL	—
default_value	object	OPTIONAL	—
id	string	OPTIONAL	—
type	string	OPTIONAL	— type16 TEXTNUMBERTOGGLECHECKBOXSELECTMULTI_SELECTCATEGORYDATEPERSONPHONEEMAILURLRATINGRELATIONLOOKUPROLLUP
select_column	object	OPTIONAL	—
category_column	object	OPTIONAL	—
required	boolean	OPTIONAL	—

Database Table_ Database Row

#

Database Table_ Database Row schema.

Field	Type		Description
cells	array of DatabaseTable_DatabaseRow_DatabaseCell	OPTIONAL	—
id	string	OPTIONAL	—

Domain Diagram

#

Domain Diagram schema.

Field	Type		Description
layout	string	OPTIONAL	— layout3 LAYOUT_UNSPECIFIEDTOP_DOWNLEFT_RIGHT
dfd	Domain Diagram_ Dfd Diagram	OPTIONAL	—
uml	Domain Diagram_ Uml Diagram	OPTIONAL	—
erd	Domain Diagram_ Erd Diagram	OPTIONAL	—
type	string	OPTIONAL	— type3 UMLDFDERD

Domain Diagram_ Dfd Diagram

#

Domain Diagram_ Dfd Diagram schema.

Field	Type		Description
connectors	array of DomainDiagram_DiagramConnector	OPTIONAL	—
nodes	array of DomainDiagram_DfdNode	OPTIONAL	—
edges	array of DomainDiagram_DiagramEdge	OPTIONAL	—

Domain Diagram_ Erd Diagram

#

Domain Diagram_ Erd Diagram schema.

Field	Type		Description
connectors	array of DomainDiagram_DiagramConnector	OPTIONAL	—
nodes	array of DomainDiagram_ErdNode	OPTIONAL	—
edges	array of DomainDiagram_DiagramEdge	OPTIONAL	—

Domain Diagram_ Uml Diagram

#

Domain Diagram_ Uml Diagram schema.

Field	Type		Description
connectors	array of DomainDiagram_DiagramConnector	OPTIONAL	—
nodes	array of DomainDiagram_UmlNode	OPTIONAL	—
edges	array of DomainDiagram_DiagramEdge	OPTIONAL	—

Fill

#

Fill schema.

Field	Type		Description
no_fill	object	OPTIONAL	—
solid	Fill_ Solid Fill	OPTIONAL	—
gradient	Fill_ Gradient Fill	OPTIONAL	—
alpha	string	OPTIONAL	—
picture	Fill_ Picture Fill	OPTIONAL	—

Fill_ Gradient Fill

#

Fill_ Gradient Fill schema.

Field	Type		Description
linear	object	OPTIONAL	—
radial_angular	object	OPTIONAL	—
stops	array of Fill_GradientFill_Stop	OPTIONAL	—
type	string	OPTIONAL	— type5 LINEARRADIALRECTANGULARPATHANGULAR

Fill_ Picture Fill

#

Fill_ Picture Fill schema.

Field	Type		Description
offset_top	string	OPTIONAL	—
scale_y	string	OPTIONAL	—
scale_x	string	OPTIONAL	—
media	Asset Ref	OPTIONAL	—
type	string	OPTIONAL	— type2 SCALETILE
offset_left	string	OPTIONAL	—

Fill_ Solid Fill

#

Fill_ Solid Fill schema.

Field	Type		Description
color	Color	OPTIONAL	—

Graphic Object Properties

#

Graphic Object Properties schema.

Field	Type		Description
strokes	array of Stroke	OPTIONAL	—
stroke_style	Asset Ref	OPTIONAL	—
shadow	Shadow	OPTIONAL	—
reflection	Reflection	OPTIONAL	—
effect_style	Asset Ref	OPTIONAL	—
region_id	string	OPTIONAL	—
fill_style	Asset Ref	OPTIONAL	—
spacing_style	Asset Ref	OPTIONAL	—
data_binding	string	OPTIONAL	—
layer_style	Asset Ref	OPTIONAL	—
layout	Layout	OPTIONAL	—
image_style	Asset Ref	OPTIONAL	—
placeholder	Placeholder	OPTIONAL	—
fills	array of Fill	OPTIONAL	—

Index Path

#

Index Path schema.

Field	Type		Description
indices	array of object	OPTIONAL	—

Kit Shape

#

Kit Shape schema.

Field	Type		Description
dfd	object	OPTIONAL	—
uml	object	OPTIONAL	—
erd	object	OPTIONAL	—
kit	string	OPTIONAL	— kit3 UMLDFDERD

Layout_ Constraints

#

Layout_ Constraints schema.

Field	Type		Description
horizontal	string	OPTIONAL	— horizontal5 LEFTRIGHTCENTERLEFT_RIGHTHORIZONTAL_SCALE
vertical	string	OPTIONAL	— vertical5 TOPBOTTOMMIDDLETOP_BOTTOMVERTICAL_SCALE

Library Asset Ref

#

Library Asset Ref schema.

Field	Type		Description
library_id	string	OPTIONAL	—
asset_id	string	OPTIONAL	—

Para Style_ List Style

#

Para Style_ List Style schema.

Field	Type		Description
number	object	OPTIONAL	—
character	object	OPTIONAL	—
color	Color	OPTIONAL	—
type	string	OPTIONAL	— type3 NONECHARACTERNUMBER

Para Style_ Spacing

#

Para Style_ Spacing schema.

Field	Type		Description
before	string	OPTIONAL	—
line	string	OPTIONAL	—
after	string	OPTIONAL	—

Picture

#

Picture schema.

Field	Type		Description
media	Asset Ref	OPTIONAL	—
filters	Picture Filters	OPTIONAL	—
properties	Graphic Object Properties	OPTIONAL	—

Picture Filters

#

Picture Filters schema.

Field	Type		Description
brightness	string	OPTIONAL	—
color_mode	object	OPTIONAL	—
contrast	string	OPTIONAL	—

Picture Filters_ Color Mode_ Bilevel

#

Picture Filters_ Color Mode_ Bilevel schema.

Field	Type		Description
level	string	OPTIONAL	—

Picture Filters_ Color Mode_ Duotone

#

Picture Filters_ Color Mode_ Duotone schema.

Field	Type		Description
first_color	Color	OPTIONAL	—
second_color	Color	OPTIONAL	—

Reflection

#

Reflection schema.

Field	Type		Description
alpha_start	string	OPTIONAL	—
distance	string	OPTIONAL	—
alpha_end	string	OPTIONAL	—
position_end	string	OPTIONAL	—
position_start	string	OPTIONAL	—

Resource Ref

#

Resource Ref schema.

Field	Type		Description
content_type	string	OPTIONAL	—
id	string	OPTIONAL	—
uri	string	OPTIONAL	—

Shadow

#

Shadow schema.

Field	Type		Description
distance	string	OPTIONAL	—
color	Color	OPTIONAL	—
transparency	string	OPTIONAL	—
angle	string	OPTIONAL	—
blur	string	OPTIONAL	—
type	string	OPTIONAL	— type2 INNEROUTER

Shape

#

Shape schema.

Field	Type		Description
callout	object	OPTIONAL	—
mathematical_symbol	object	OPTIONAL	—
star	object	OPTIONAL	—
custom	Custom Shape	OPTIONAL	—
block_arrow	object	OPTIONAL	—
flowchart	object	OPTIONAL	—
text	Text	OPTIONAL	—
basic	object	OPTIONAL	—
properties	Graphic Object Properties	OPTIONAL	—

Stroke

#

Stroke schema.

Field	Type		Description
captype	string	OPTIONAL	— captype3 FLATCAPROUNDSQUARE
jointype	string	OPTIONAL	— jointype3 ROUNDBEVELMITER
width	string	OPTIONAL	—
position	string	OPTIONAL	— position3 CENTERINSIDEOUTSIDE
type	string	OPTIONAL	— type9 SOLIDDASHROUND_DOTSQUARE_DOTLONG_DASHDASHDOTLONG_DASH_DOTLONG_DASH_DOT_DOTDASH_PATTERN
fill	Fill	OPTIONAL	—
dash_pattern	array of object	OPTIONAL	—

Structure

#

Structure schema.

Field	Type		Description
stack	Structure_ Stack	OPTIONAL	—
kanban	Structure_ Kanban	OPTIONAL	—
mindmap	Structure_ Mindmap	OPTIONAL	—
title	string	OPTIONAL	—

Structure_ Kanban

#

Structure_ Kanban schema.

Field	Type		Description
container	Vani Graphic Object_ Group Shape	OPTIONAL	—
horizontal	object	OPTIONAL	—
vertical	object	OPTIONAL	—
table_view_id	string	OPTIONAL	—

Structure_ Mindmap

#

Structure_ Mindmap schema.

Field	Type		Description
container	Vani Graphic Object_ Group Shape	OPTIONAL	—
spacing	object	OPTIONAL	—
template_object	Vani Graphic Object_ Group Shape	OPTIONAL	—
top	Vani Graphic Object_ Group Shape	OPTIONAL	—
left	Vani Graphic Object_ Group Shape	OPTIONAL	—
bottom	Vani Graphic Object_ Group Shape	OPTIONAL	—
root	Vani Graphic Object_ Group Shape	OPTIONAL	—
top_down	object	OPTIONAL	—
right	Vani Graphic Object_ Group Shape	OPTIONAL	—
left_right	object	OPTIONAL	—

Structure_ Stack

#

Structure_ Stack schema.

Field	Type		Description
container	Vani Graphic Object_ Group Shape	OPTIONAL	—
horizontal	object	OPTIONAL	—
vertical	object	OPTIONAL	—
table_view_id	string	OPTIONAL	—

Table

#

Table schema.

Field	Type		Description
layout	Layout	OPTIONAL	—
columns	array of Table_TableColumn	OPTIONAL	—
style_ref	Asset Ref	OPTIONAL	—
style	Table Style	OPTIONAL	—
rows	array of Table_TableRow	OPTIONAL	—

Table Style

#

Table Style schema.

Field	Type		Description
band_row	boolean	OPTIONAL	—
first_col	boolean	OPTIONAL	—
band_col	boolean	OPTIONAL	—
first_row	boolean	OPTIONAL	—
last_row	boolean	OPTIONAL	—
fill	Fill	OPTIONAL	—
stroke	Stroke	OPTIONAL	—
last_col	boolean	OPTIONAL	—

Table_ Table Column

#

Table_ Table Column schema.

Field	Type		Description
width	string	OPTIONAL	—
id	string	OPTIONAL	—

Table_ Table Row

#

Table_ Table Row schema.

Field	Type		Description
cells	array of Table_TableRow_TableCell	OPTIONAL	—
id	string	OPTIONAL	—
height	string	OPTIONAL	—

Vani Graphic Object

#

Vani Graphic Object schema.

Field	Type		Description
shape	Vani Shape	OPTIONAL	—
sticky_note	Vani Graphic Object_ Sticky Note	OPTIONAL	—
group_shape	Vani Graphic Object_ Group Shape	OPTIONAL	—
database_table	Database Table	OPTIONAL	—
picture	Picture	OPTIONAL	—
structure	Structure	OPTIONAL	—
domain_diagram	Domain Diagram	OPTIONAL	—
diagram	object	OPTIONAL	—
connector	Connector	OPTIONAL	—
name	string	OPTIONAL	—
database_table_view	Database Table View	OPTIONAL	—
id	string	OPTIONAL	—
chart	Chart	OPTIONAL	—
table	Table	OPTIONAL	—

Vani Graphic Object_ Group Shape

#

Vani Graphic Object_ Group Shape schema.

Field	Type		Description
layout	Layout	OPTIONAL	—
auto_layout	Auto Layout	OPTIONAL	—
objects	array of VaniGraphicObject_GroupShape_GroupObject	OPTIONAL	—

Vani Graphic Object_ Group Shape_ Group Object

#

Vani Graphic Object_ Group Shape_ Group Object schema.

Field	Type		Description
shape	Vani Shape	OPTIONAL	—
connector	Connector	OPTIONAL	—
sticky_note	Vani Graphic Object_ Sticky Note	OPTIONAL	—
name	string	OPTIONAL	—
group_shape	Vani Graphic Object_ Group Shape	OPTIONAL	—
id	string	OPTIONAL	—
picture	Picture	OPTIONAL	—

Vani Graphic Object_ Sticky Note

#

Vani Graphic Object_ Sticky Note schema.

Field	Type		Description
layout	Layout	OPTIONAL	—
type	string	OPTIONAL	— type8 STICKY_NOTE_TYPE_UNSPECIFIEDARROWFLAGRINGPLAINCLIPPINFOLDED

Vani Shape

#

Vani Shape schema.

Field	Type		Description
shape	Shape	OPTIONAL	—
kit	Kit Shape	OPTIONAL	—

View Config

#

View Config schema.

Field	Type		Description
filter	object	OPTIONAL	—
visible_column_ids	array of object	OPTIONAL	—
group_by_column_id	string	OPTIONAL	—
sort	array of Sort	OPTIONAL	—