Class: GOBL::Org::Image

Inherits:
GOBL::Object show all
Defined in:
lib/generated/gobl/org/image.rb

Overview

Image describes a logo or photo that represents an entity.

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL Image structure

'https://gobl.org/draft-0/org/image'

Instance Attribute Summary collapse

Method Summary

Methods inherited from GOBL::Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

#alt ⇒ String (readonly)

Alternative text if the image cannot be shown.

Returns:

  • (String) 


48
 
# File 'lib/generated/gobl/org/image.rb', line 48

property :alt, String

#data ⇒ String (readonly)

As an alternative to the URL and only when the source data is small, like an SVG, the raw data may be provided using Base64 encoding.

Returns:

  • (String) 


33
 
# File 'lib/generated/gobl/org/image.rb', line 33

property :data, String

#description ⇒ String (readonly)

Details of what the image represents.

Returns:

  • (String) 


43
 
# File 'lib/generated/gobl/org/image.rb', line 43

property :description, String

#digest ⇒ GOBL::DSig::Digest (readonly)

Digest can be used to ensure the image contained at the URL is the same one as originally intended.

Returns:



63
 
# File 'lib/generated/gobl/org/image.rb', line 63

property :digest, GOBL::DSig::Digest

#height ⇒ Integer (readonly)

Height of the image in pixels.

Returns:

  • (Integer) 


53
 
# File 'lib/generated/gobl/org/image.rb', line 53

property :height, Integer

#label ⇒ String (readonly)

Label to help identify the image.

Returns:

  • (String) 


23
 
# File 'lib/generated/gobl/org/image.rb', line 23

property :label, String

#meta ⇒ GOBL::CBC::Meta (readonly)

Meta contains additional information about the image.

Returns:



68
 
# File 'lib/generated/gobl/org/image.rb', line 68

property :meta, GOBL::CBC::Meta

#mime ⇒ String (readonly)

Format of the image.

Returns:

  • (String) 


38
 
# File 'lib/generated/gobl/org/image.rb', line 38

property :mime, String

#url ⇒ String (readonly)

URL of the image

Returns:

  • (String) 


28
 
# File 'lib/generated/gobl/org/image.rb', line 28

property :url, String

#uuid ⇒ String (readonly)

Universally Unique Identifier.

Returns:

  • (String) 


18
 
# File 'lib/generated/gobl/org/image.rb', line 18

property :uuid, String

#width ⇒ Integer (readonly)

Width of the image in pixels.

Returns:

  • (Integer) 


58
 
# File 'lib/generated/gobl/org/image.rb', line 58

property :width, Integer