GoodocOrdinal

Posted on by Darth Autocrat

GoogleApi.ContentWarehouse.V1.Model.GoodocOrdinal

Table of Contents ▼

Jump to a specific part of the page:

Description

An Ordinal message represents a single ordinal component of a page number. It encodes the printed or inferred numbering style (Roman, ASCII, etc.) and the ordinal value of the component. An optional set of variable is defined in order to express a sectioned ordinal. A sectioned ordinal may appear in certain page numbering styles, for example "12-1" where "12" identifies a chapter and "1" identifies the page within it. This case will be encoded with value 1 and section_value 12 both of type ASCII.

Attributes List

This module has the following attributes (case-insensitive ascending order):

View Attributes

Attributes

  1. implicit (type: String.t, default: nil)
    -
  2. sectionStringValue (type: String.t, default: nil)
    -
  3. sectionValue (type: integer(), default: nil)
    -
  4. sectionValueType (type: String.t, default: nil)
    - The following vars describe the section component of an ordinal (if exists). They are used to express situation where a page number has a section component, usually denoating the chapter number. For example pages 5-14, 5-15 will both have the common section 5. (If exists). The semantcis of the section variables correspond to that of the primary part of the ordinal. (Described above).
  5. stringValue (type: String.t, default: nil)
    - The string page value.
  6. value (type: integer(), default: nil)
    - The numeric page value.
  7. valueDelta (type: String.t, default: nil)
    - The delta in which the value increases between pages.
  8. valueType (type: String.t, default: nil)
    - A value type from the Type enum above.

Type

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.GoodocOrdinal{
implicit: String.t() | nil,
sectionStringValue: String.t() | nil,
sectionValue: integer() | nil,
sectionValueType: String.t() | nil,
stringValue: String.t() | nil,
value: integer() | nil,
valueDelta: String.t() | nil,
valueType: String.t() | nil
}

Function

@spec decode(struct(), keyword()) :: struct()

Data sourced from HexDocs : GoogleApi.ContentWarehouse.V1.Model.GoodocOrdinal